README.md

NestJS Starter App

This is a dockerized NestJS starter app with authentication built-in.

Table of Contents

• Features
• Concepts Employed
• Built With
• Required Installations
• Installation
• Future Improvements
• License
• Contact
• Acknowledgements

Features

• Authentication using passport local (email and password) and JWT strategies with cookies.
• Validation with class-validator
• Unit and integration tests (jest and supertest)
• Containerization with docker compose.
• ActiveRecord data modelling with TypeORM

Concepts Employed

• Typescript - interfaces, generics and type definitions
• Nest Guards
• Nest pipes
• Nest interceptors
• Nest exception filters
• Containerization - Docker

Built With

• NestJs
• Postgres
• TypeORM
• PassportJS
• Docker

REQUIRED INSTALLATIONS

• Node
• Docker desktop

Installation

Once you have installed the requiered packages shown on the Required Installations, proceed with the following steps

Ensure you have docker desktop installed and running

Clone the Repository,

your@pc:~$ git clone https://github.com/frankly034/nestjs-starter.git

Move to the downloaded folder

your@pc:~$ cd nestjs-starter

Run with docker-compose

your@pc:~$ docker-compose up

Future Improvements

• Add SSO

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• 🇳🇬 Lewis Ugege - franklynugege@gmail.com | Github Account | Twitter | Linkedin |

Acknowledgements

• NestJS
• Marcin Wanago