README.md

A NestJS boilerplate for starting a new project faster.

Description

Quizzfly Server [NestJs]

Getting started

# Create environment variables file.
cp .env.example .env

# Install dependences.
npm install

Checklist

When you use this template, try follow the checklist to update your info properly

• Change the author name in LICENSE
• Change configurations in .env
• Remove the .github folder which contains the funding info
• Clean up the README.md file

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

# Generate a module(resource)
$ nest g res modules/$name_module

Features

• Database. Support TypeORM
• Seeding (Typeorm Extension).
• Config Service (@nestjs/config).
• Mailing (@nestjs-modules/mailer & nodemailer).
• Sign in and sign up via email.
• Social sign in (Apple, Facebook, Google, Twitter).
• Admin and User roles.
• Pagination: Offset and Cursor (Clone from typeorm-cursor-pagination and add more features).
• Internationalization/Translations (I18N) (nestjs-i18n).
• File uploads. Support local and Amazon S3 drivers.
• Swagger.
• E2E and units tests.
• Docker.
• CI (Github Actions).

More documentations

Please read the docs. It contains the details about the project structure, conventions, and more.

References

• Awesome Nest Boilerplate
• Brocoders NestJS Boilerplate

Support

Discuss on Github