MiroslavPetrik/nest-mongo-api-starter

Full-featured starter for Typescript Node & Mongo Rest API featuring NestJS

nest-mongo-api-starter

Full-featured starter for Typescript Node & Mongo Rest API server featuring NestJS!

Getting started

1. Install packages with yarn install
2. Create env file cp .env.example .env
   1. Configure mongo db URL (e.g. one pointing to Mongo Atlas)
3. Develop app yarn start:dev

What's Inside

• dotenv environment variables
• MongoDB/mongoose configuration
• Passport authentication
• Validation with class-validator
• Mailer
• Serve-static middleware
  • example files
    • http://localhost:3001/public/swagger.png
    • http://localhost:3001/public/tests.png
• Compression
• Security with helmet
• Logging middleware (Bunyan)
• Swagger documentation
• Access logs with Morgan interceptor

Authorization features with end-to-end tests:

Features:

• user signup
• user activation
• user login
• user relogin
• password reset
• forgotten password

Configuring swagger

This project uses modular swagger configuration. Each feature has it's own swagger document. Follow these steps to add new feature:

1. In feature folder create feature.swagger.ts file.
2. Call setupSwaggerDocument and export the returned function.
3. Register feature module in feature.module.ts by calling the exported function from step 2.
4. Access your document at /docs/:featurePath.

For a concrete example see the auth feature.

More

This backend will play nicely with awesome react-starter create-react-app project written in Typescript!

License

MIT