https://github.com/amruthpillai/nestjs-starter
A NestJS starter template with Database and Authentication Scaffolding
https://github.com/amruthpillai/nestjs-starter
Last synced: 7 months ago
JSON representation
A NestJS starter template with Database and Authentication Scaffolding
- Host: GitHub
- URL: https://github.com/amruthpillai/nestjs-starter
- Owner: AmruthPillai
- Created: 2022-01-04T20:22:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T21:38:22.000Z (over 1 year ago)
- Last Synced: 2024-05-02T05:37:17.694Z (over 1 year ago)
- Language: TypeScript
- Size: 218 KB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NestJS Starter
A NestJS starter template with Database and Authentication Scaffolding
### Features
- `.env` validation (using dotenv and Joi)
- Local & JWT Authentication (using Passport)
- PostgresDB Database Management (using TypeORM)
- Forgot Password / Reset Password flows, with emails (using Nodemailer)
- Dynamic Email Templates (using handlebars)
### How to Run?
- Clone the repository and `cd` into the project directory
- Copy `.env.example` to `.env` and populate with your respective secrets
- Fire up PostgresDB through Docker by running `docker compose up -d`
- Install project dependencies by running `yarn install` (or `npm install`)
- Run the server locally in debug mode, by running `yarn start:dev` (or `npm run start:dev`)
- When you are ready to deploy, build the project using `yarn build` (or `npm run build`)