/template-node-typescript-backend

My Starter Kit Template to develop a typescript-based backend

Primary LanguageTypeScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Template NodeJs Typescript BackEnd

Project WIP.

About

This Starter Kit Template can be the foundation of a TypeScript & TypeORM Node.js Backend Below are the implemented features:

  • Sign Up
  • Login
  • Auth Middlewares
  • Routes testing
  • Logging
  • Heroku deploy ready

Technologies

The following tools and frameworks were used in the construction of the project:

NodeJS ExpressJS TypeScript TypeORM

Node

Express

Typescript

TypeOrm
Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications TypeScript is an open-source language which builds on JavaScript, one of the world’s most used tools, by adding static type definitions TypeORM is an ORM that can run in NodeJS, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo, and Electron platforms and can be used with TypeScript and JavaScript (ES5, ES6, ES7, ES8)

How to run

  1. Clone this repository
  2. Install dependencies
npm i
  1. Create a PostgresSQL database "your_database_dev" and "your_database_test"
  2. rename example.local.dev.env -> local.dev.env and example.local.test.env -> local.test.env
  3. Config .env files as indicated
  4. Run the Backend with
npm run dev
  1. Finally access http://localhost:4000/api/"desired-route" on your favorite API Client

License

This sample application is licensed under the BSD-3-Clause License, Revised version. Separate third-party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 and the BSD-3-Clause License, Revised version.