This is a demo for GBL

• Features
• Pre-reqs
• Getting stated
  • Clone and install deps
  • Configure environment
  • Running pre-reqs scripts
  • Starting up the server

• Typescript
• Follows service-controller design pattern
• Supported database - Postgres with knex query builder
• Role based Authentication and Authorization
• Middlewares
  • Authorization (Role based)
  • Ratelimiter
  • Joi Validator
  • Pino Logger
  • ErrorHandler
• Redis / Memory cache support
• Swagger documentation (Do /api-docs to see the docs)
• Deployed on Heroku (Note: While using Knex, heroku run knex --knexfile build/database/knexfile.js migrate:latest --app gbl-demo Also, to fix the authentication issue: heroku config:set PGSSLMODE=no-verify --app gbl-demo )

To build and run this app locally you will need a few things:

• Environment - Nodejs
• Database - Postgresql

git clone https://github.com/aarav22/gbl-demo-backend.
git --branch <branch-name> <project-name>

cd <project-name>

# yarn is recommended
# install yarn if not installed already
npm i -g yarn@latest

yarn install

Create .env file by replicating .env.example and fill as per needs. To properly run this project, you will need to setup following variables to your .env file.

• Server

• JWT

# you can use this command in cli to easily generate random base64 string
# and use it as secret string or you can use any secret-string as per your wish.
node -e "console.log(require('crypto').randomBytes(64).toString('base64'))"

• Database credentials

Change XXXX with either one of these DEV, TEST, PROD.

Depending on your environment or you can use all at once as-well

# Development
DB_DEV_DATABASE=template
DB_DEV_USER=postgres
DB_DEV_PASS=root

# TEST
DB_TEST_DATABASE=template_test
DB_TEST_USER=postgres
DB_TEST_USER=root

# Production
DB_PROD_DATABASE=template
DB_PROD_USER=username
DB_PROD_PASS=password

• Logger

# migrate base tables
yarn knex:migrate

# seed database with genesis block
yarn knex:seed

# start application with development environment
yarn start:dev

# you can use legacy if above command doesn't seems to work
# yarn start:dev-legacy

• Tests

# unit testing with jest and supertest
yarn test:unit

• Linting

# lint check
yarn lint

# lint fix
yarn lint --fix

• @aarav22
• For Template: @dhruvsaxena1998