README.md

CRUD API Node Server Boilerplate

A boilerplate/starter project for quickly building CRUD API using Node.js, Express, Pug and Postgres.

Project structure

.
├── ./api
├── ./config
├── ./controllers
├── ./middlewares
├── ./models
├── ./public
├── ./routes
├── ./scratch
├── ./validate
├── ./views
├── ./key.js
└── ./server.js

Install

Clone the repo:

git clone https://github.com/ductnn/nodejs-postgresql-boilerplate.git
cd nodejs-postgresql-boilerplate

Install the dependencies:

npm install

Note: Install nodemon (optional) on golbal scope in your host machine (flag -g) using npm

Set the enviroment variables:

cp .env.example .env

# open .env and modify the environment variables (if needed)

Commands

Start API server:

npm start

or

npm run dev

Note: If you don't use nodemon start server by node server.js

Contribution

Contributions are more than welcome in this project!

License

The MIT License (MIT). Please see LICENSE for more information.