ACK NestJs Boilerplate 🔥 🚀

This repo will representative of authentication service and authorization service

ACK NestJs is a Http NestJs v10.x boilerplate. Best uses for backend service.

You can request feature or report bug with following this link

Table of contents

• ACK NestJs Boilerplate 🔥 🚀
  • Table of contents
  • Important
  • Todo
  • Documentation
  • License
  • Contribute
  • Contact

Important

Very limited documentation

• The features will be relate with AWS / Amazon web service
• Stateless Authorization
• If you want to implement database transactions. You must run MongoDB as a replication set.
• If you want to implement Google SSO. You must have google cloud console account, then create your own SSO / Credential API to get the clientId and clientSecret.
• If you change the environment value of APP_ENV to production, that will trigger.
  1. CorsMiddleware will implement config from src/configs/middleware.config.ts.
  2. Documentation will disable.
• For monitoring, this project will use sentry.io, and only send 500 or internal server error.

Todo

• Remove Debugger HTTP
• Setting Move to Modules
• Debugger env change
• Add exception filter to Sentry.io
• Add Email Module with AWS SES
• CI Push docker image to AWS ECR, currently using Docker Hub
• CD Using AWS ECS and deploy to AWS EC2, currently only using AWS EC2
• Update Package, and remove unused package
• Update Documentation, add behaviors
• Update Documentation, and include an diagram for easier comprehension
• Add Redis / Move to stateful Authorization Token (security and ux reason)
• Implement GraphQL, just an options for running ?

Documentation

Documentation of ack-nestjs-boilerplate in /docs

License

Distributed under MIT licensed.

Contribute

How to contribute in this repo

1. Fork the project with click Fork button of this repo.

2. Clone the fork project

   git clone "url you just copied"

3. Make necessary changes and commit those changes

4. Commit the changes

   git commit -m "your message"

5. Push changes to fork project

   git push origin -u main

6. Back to browser, goto your fork repo github. Then, click Compare & pull request

If your code behind commit with the original, please update your code and resolve the conflict. Then, repeat from number 6.

Contact

Andre Christi kan