NodeSeQ - Node Typescript Sequelize PostgreSQL Boilerplate
APACHE-2.0 License
Quick start
Continuous Integration
Documentation Standards
Test Coverage Maintenance
Production Ready Setup
express
, @types/express
@types/node
typescript
dotenv
cors
helmet
http-status-codes
winston
sequelize
, pg
, pg-hstore
git clone https://github.com/santoshshinde2012/node-ts-sequelize-pg-boilerplate.git
npm install
npm run dev
npm run test
npm run db:up
npm install
npm run build
npm run start
.env
values for your refrence just check .env.example
Name | Description |
---|---|
docker/ | Docker related config for postgresql db |
wiki/ | You can add project documentation and insructions file here |
src/ | Source files |
src/abstractions | Abstarct classes and Interfaces |
src/components | REST API Components & Controllers |
src/database | Database config and models |
src/lib | Reusable utilises and library source code like a logger |
src/middleware/ | Express Middlewares like error handler feature |
build/ | Compiled source files will be placed here |
tests/ | Test cases will be placed here |
tests/helpers/ | Helpers for test cases will be placed here |
tests/unit-tests/ | Unit Test cases will be placed here |
tests/integration-tests/ | API routes (Integration) Test cases will be placed here |
The Postman Collections is available in public workspace.
The swagger documentation is available at the following url ${host}/docs
: