Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leizhenpeng/starter-nestjs
Starter template for NestJs library
https://github.com/leizhenpeng/starter-nestjs
jwt nestjs pino-logs postgresql prisma redis swagger
Last synced: 16 days ago
JSON representation
Starter template for NestJs library
- Host: GitHub
- URL: https://github.com/leizhenpeng/starter-nestjs
- Owner: Leizhenpeng
- License: mit
- Created: 2022-08-14T12:27:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-14T09:19:52.000Z (about 2 years ago)
- Last Synced: 2024-12-02T07:57:46.594Z (20 days ago)
- Topics: jwt, nestjs, pino-logs, postgresql, prisma, redis, swagger
- Language: TypeScript
- Homepage:
- Size: 295 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Starter-Nestjs 
This project contains boilerplate for creating APIs using [Nest](https://nestjs.com), a progressive [Node.js](http://nodejs.org) framework for building efficient and scalable server-side applications.
It is mostly built to be used as a starting point in hackathons and implements common operations such as sign up, JWT authentication, mail validation, model validation and database access.
You can also look at my [Angular Hackathon Starter](https://github.com/ahmetuysal/angular-hackathon-starter) template that shares the same contract with this API.
## Features
1. **PostgreSQL with Prisma**
2. **Pino Logger**
3. **Redis**
4. **socket-io**
5. **Request Validation**
6. **JWT Authentication**
7. **Swagger API Documentation**
8. **LOGIN Module**
9. **Email Module**
## Getting Started
### Installation
1. Make sure that you have [Node.js](https://nodejs.org)(>= 10.13.0, except for v13) installed.
2. Clone this repository by running `git clone https://github.com/ahmetuysal/nest-hackathon-starter.git ` or [directly create your own GitHub repository using this template](https://github.com/ahmetuysal/nest-hackathon-starter/generate).
3. Move to the appropriate directory: `cd `.
4. Run `yarn` to install dependencies.
### Configuration Files
#### [Prisma](https://github.com/prisma/prisma) Configurations
This template uses Postgres by default. If you want to use another database, follow instructions in the [official Nest recipe on Prisma](https://docs.nestjs.com/recipes/prisma).
If you wish to use another database you will also have to edit the connection string on [`prisma/.env`](prisma/.env) file accordingly.
Template includes three different environment options by default. Most of the time you will use the `local`
environment when developing and `production` environment on production. You will need to fill out corresponding
environment files in [`env`](env) directory.
```dosini
DATABASE_HOST=__YOUR_DATABASE_URL__
DATABASE_PORT=5432
DATABASE_USERNAME=__YOUR_USERNAME__
DATABASE_PASSWORD=__YOUR_PASSWORD__
DATABASE_NAME=__YOUR_DATABASE__
```
#### JWT Configurations
A secret key is needed in encryption process. Generate a secret key using a service like [randomkeygen](https://randomkeygen.com/).
Enter your secret key to [`config.ts`](src/config.ts) file. You can also the change expiration time, default is 86400 seconds(1 day).
```js
jwt: {
secretOrKey: '__JWT_SECRET_KEY__',
expiresIn: 86400,
},
```
#### [NodeMailer✉️](https://github.com/nodemailer/nodemailer) Configurations
A delivery provider is required for sending mails with Nodemailer. I mostly use [SendGrid](https://sendgrid.com) to send mails, however, Nodemailer can work with any service with SMTP transport.
To get a SendGrid API key:
- Create a free account from [https://signup.sendgrid.com/](https://signup.sendgrid.com/)
- Confirm your account via the activation email and login.
- Create an API Key with mail sending capability.
Enter your API key and sender credentials to [`config.ts`](src/config.ts) file. Sender credentials are the sender name and sender mail that will be seen by your users.
```js
mail:
service: {
host: 'smtp.sendgrid.net',
port: 587,
secure: false,
user: 'apikey',
pass: '__SENDGRID_API_KEY__',
},
senderCredentials: {
name: '__SENDER_NAME__',
email: '__SENDER_EMAIL__',
},
},
```
#### Mail Template Configurations
Mail templates are highly customizable and heavily depend on configurations. Enter your project's information to [`config.ts`](src/config.ts). Urls are used as references in the templates. If your mail verification logic is independent from your front-end application, you can use API's own mail verification endpoint, e.g. `http://localhost:3000/auth/verify`, as `mailVerificationUrl`. Otherwise, send a HTTP `GET` request to verification endpoint with token added as a parameter named token, e.g, `http://localhost:3000/auth/verify?token=__VERIFICATION_TOKEN__`
```js
project: {
name: '__YOUR_PROJECT_NAME__',
address: '__YOUR_PROJECT_ADDRESS__',
logoUrl: 'https://__YOUR_PROJECT_LOGO_URL__',
slogan: 'Made with ❤️ in Istanbul',
color: '#123456',
// You can enter as many social links as you want
socials: [
['GitHub', '__Project_GitHub_URL__'],
['__Social_Media_1__', '__Social_Media_1_URL__'],
['__Social_Media_2__', '__Social_Media_2_URL__'],
],
url: 'http://localhost:4200',
mailVerificationUrl: 'http://localhost:3000/auth/verify',
mailChangeUrl: 'http://localhost:3000/auth/change-email',
resetPasswordUrl: 'http://localhost:4200/reset-password',
termsOfServiceUrl: 'http://localhost:4200/legal/terms',
},
```
### Migrations
Please refer to the official [Prisma Migrate Guide](https://www.prisma.io/docs/guides/database/developing-with-prisma-migrate) to get more info about Prisma migrations.
```bash
# generate migration for local environment
$ yarn migrate:dev:create
# run migrations in local environment
$ yarn migrate:dev
# deploy migration to prod environment
$ yarn migrate:deploy:prod
```
### Running the app
```bash
# development mode
$ yarn start:dev
# production
$ yarn build
$ yarn start:prod
```
### Running the tests
```bash
# unit tests
$ yarn test
# e2e tests
$ yarn test:e2e
# test coverage
$ yarn test:cov
```
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Support Nest
Nest is an MIT-licensed open source project. If you'd like to join support Nest, please [read more here](https://docs.nestjs.com/support).
## License
Licenced under [MIT License](LICENSE). Nest is also MIT licensed.