An API to manage our community data
- Commits follow the standard Conventional Commit
- Branches should be named as
issue-<issue no>
(e.g. NestJs issue number is 12)
$ npm install
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
- start the app
npm start
- visit
http://localhost:3000/swagger
Official docs at https://docs.nestjs.com/openapi/introduction
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
Logging can be turned on by settings an environmentvariable DEBUG=true
If this variables is not true or undefiend no Logs will be made.
When set to true
the App will Log every incoming request.
docker run -p 3000:3000 -d ghcr.io/eddiehubcommunity/api:latest
- Visit
http://localhost:3000/