TypeScript node starter

Purpose of this template is to get started in minutes with nodejs and typscript and all the workflow already setup

Documentation

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

Features

• 100% written in typescript
• Follows service-controller design pattern
• Supported database - Postgres with knex query builder
• Authentication and Authorization pre-setup
• Middlewares
  • Authorization (Role based)
  • Ratelimiter
  • Joi Validator
  • Pino Logger
  • ErrorHandler
• Redis / Memory cache supported
• Swagger documentation
• Testing with jest and supertest
• Eslint and prettier linting
• And minor common utils npm packages lodash

All pre-configured or very minimum configuration required*

Pre-reqs

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

• Envirnoment - Nodejs
• Editor - VS Code

• Database - Postgresql

  MySQL [wip]

Getting started

Clone the repository

git clone https://github.com/dhruvsaxena1998/node-express-typescript.git --branch <branch-name> <project-name>

Install dependencies

cd <project-name>

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

yarn install

Configure your environment

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

key	default value	description
SERVER_HOST	localhost	host on which server will run
SERVER_PORT	5000	port on which server will run

• JWT

key	default value	description
JWT_EXPIRES	30d	expiry for jwt-tokens, eg. 1d, 10d
JWT_SECRET	a606f398-51e9-4ba8-b8bb-02326f666bdf	secret from which tokens will be signed and verified

# 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

key	default value
DB_XXXX_HOST	localhost
DB_XXXX_PORT	5432
DB_XXXX_DATABASE	template
DB_XXXX_USER	admin
DB_XXXX_PASS	root

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

key	default value	description
LOG_LEVEL	debug	set default log-level

Run pre-reqs scripts

# migrate base tables
yarn knex:migrate

# seed database with genesis block
yarn knex:seed

Run locally and start the server

# 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

Authors

• @dhruvsaxena1998