shamazkhan / quantlcharts

For Quantl Charts and MongoDB

🎫 A Class Base Routing Boilerplate for Node.js, Express.js, MongoDB with Typescript.

What is it?

Try to implement A Class Base Routing with clean structure and scalable boilerplate in Node.js,Express.js and Typescript.

Features

• Sentry catch errors.
• API Documentation using Swagger.
• Basic Security Features using Helmet, hpp and xss clean.
• Validation using class-validator
• class base routing using routing-controllers
• Authentication - using Passport.js passport-jwt which is compatible with Express.js and is a authentication middleware for Node.js.
• Database using mongoose odm for interacting with mongoDB.
• run testing using Jest
• linting using ESLint
• prettier using Prettier

Getting Started

install dependencies

yarn

Without Docker

Note: It is assumed here that you have MongoDB running in the background.

set .env.development.local file with your credentials.(like DB URL)

Run the app

yarn dev

With Docker

Note: It is assumed here that you have installed Docker and running in the background.

yarn docker:db

set .env.development.local file with your credentials.(like DB URL)

Run the app

yarn dev

Route Documents

you can access swagger documentation at http://localhost:3000/api-docs

What is the Structure of template?

express-typescript-boilerplate
├─ .github
│  └─ workflows
│     └─ tests.yml
├─ README.md
├─ ecosystem.config.js
├─ jest.config.js
├─ package.json
├─ src
│  ├─ __tests__
│  │  ├─ api
│  │  │  └─ v1
│  │  │     └─ auth
│  │  │     └─ users
│  ├─ api
│  │  └─ v1
│  │     ├─ auth
│  │     │  ├─ renewablesSelected.controller.ts
│  │     │  └─ dtos
│  │     ├─ index.ts
│  │     └─ user
│  │        └─ user.controller.ts
│  ├─ app.ts
│  ├─ common
│  │  ├─ constants
│  │  │  └─ index.ts
│  │  ├─ interfaces
│  │  │  ├─ crud.interface.ts
│  │  │  └─ timestamp.interface.ts
│  │  └─ types
│  ├─ config
│  │  ├─ index.ts
│  │  └─ passport.ts
│  ├─ exceptions
│  │  └─ HttpException.ts
│  ├─ index.ts
│  ├─ middlewares
│  │  ├─ auth.middleware.ts
│  │  ├─ handlingErrors.middleware.ts
│  │  └─ validation.middleware.ts
│  ├─ models
│  │  ├─ tokens.model.ts
│  │  └─ gld-spy-graph.model.ts
│  ├─ services
│  │  └─ v1
│  │     ├─ gld-spy-graph.service.ts
│  │     ├─ index.ts
│  │     ├─ token.service.ts
│  │     └─ user.service.ts
│  └─ utils
│     └─ toJSON.plugin.ts
├─ tsconfig.json

quantlcharts's Issues

Unable to deploy project on docker, Cannot GET /

getting following in browser
Cannot GET /

Coherence deployment is failing

Docker = Works
Coherence = Do Not Work (Builds ok but deployment fails)

BUILD ISSUES: Unable to build a project in docker

docker-compose up --build is failing

Error:

SentryError: Invalid Sentry Dsn: SENTRY_DSN

Define in ENV files as SENTRY_DSN=SENTRY_DSN
reffered in app.ts