Node TypeScript Boilerplate Postgres
Developer Ready: A comprehensive template. Works out of the box for most Node.js projects. This project is intended to be used with the latest Active LTS release of Node.js.
Tech Stack
Server: Node, Express
DataBase: postgres, typeorm
Run Locally
Clone the project
git clone https://github.com/chiragmehta900/node-typescript-boilerplate-postgres
Go to the project directory
cd node-typescript-boilerplate-postgres
Install dependencies
npm install
Start the tsc
npm run watch
Start the server
npm run dev
Environment Variables
To run this project, you will need to add the following environment variables to your .env file
PORT
TOKEN_SECRET
REFRESH_TOKEN_SECRET
Documentation
API Reference
Create user
POST /user/create
Parameter | Type | Description |
---|---|---|
firstName |
string |
Required. Your API key |
lastName |
string |
Required. Your API key |
email |
string |
Required. Your API key |
password |
string |
Required. Your API key |
phoneNumber |
number |
Required. Your API key |
login user
POST /user/login
Parameter | Type | Description |
---|---|---|
phoneNumber |
number |
Required. Your API key |
password |
string |
Required. Your API key |
Get all users
GET /user/list
Parameter | Type | Description |
---|---|---|
id |
uuid |
Required. Your API key |
firstName |
string |
Required. Your API key |
lastName |
string |
Required. Your API key |
email |
string |
Required. Your API key |
password |
string |
Required. Your API key |
profileImage |
string |
Required. Your API key |
isActive |
boolean |
Required. Your API key |
phoneNumber |
number |
Required. Your API key |
tocken |
string |
Required. Your API key |
refreshToken |
string |
Required. Your API key |
A postman collection has been added for better understanding.
Badges
Add badges from somewhere like: shields.io
Author
Support
For support, email [email protected] or join our Slack channel.