juanparker1 / nestgoose

NestJs with Mongoose

Instagram clone made using Nestjs + Mikro-orm codebase(backend) containing real world examples (CRUD, auth, advanced patterns, etc)

Getting started

Clone this repo. Edit the env file and pass in your credentials

Installation

Install dependencies

 yarn

Database

The example codebase uses MikroORM with a Postgres database.

Copy MikroORM config example file and adjust the connection settings and other settings(jwt,redism,mail,etc) respectively on sample env file

Start local Postgres server and run NODE_ENV=dev yarn orm:up to apply migrations

Now you can start the application witt `NODE_ENV=dev yarn start.

Note: Env files are kept in env folder. The config validation allows 4 environment ['dev', 'prod', 'test','stage']. The env file name should be of format .env.[environment] Ex. (.env.test). The env to use should be provided while running any script as NODE_ENV=dev npm run dev

---

NPM scripts

• yarn start - Start application
• yarn start:watch - Start application in watch mode
• yarn test - run Jest test runner
• yarn start:prod - Build application

---

Start application

• yarn start
• Test api by browsing to http://localhost:[port]/v1/user
• View automatically generated swagger api docs by browsing to http://localhost:[port]/docs

---

Authentication

This applications uses JSON Web Token (JWT) to handle authentication. The token is passed with each request using the Authorization header with Token scheme. The JWT authentication middleware handles the validation and authentication of the token.

Todos

FRONTEND