This is boilerplate hapi typescript project
Copy the file '.env.sample' and rename it to '.env', then update the necessary environment variables:
MONGO_URI
- Node: v16
- VSCode IDE
- Eslint vscode plugin
- Prettier vscode plugin
- Install all the dependencies using
yarn
- To run the server with watch use
yarn watch
- To run the test cases in watch mode use
yarn test-watch
- To run the test cases without watch mode use
yarn test
- To run docker compose
docker-compose -f docker-compose.dev.yml up -d
- Unit Test: We are using Jest for assertion and mocking
The seed uses husky
to enable commit hook.
Whenever there is a commit, there will be check on lint, on failure commit fails.
Whenever there is a push, there will be check on test.
Swagger API is at http://localhost:8000/{version}documentation
Example
http://localhost:8000/v1/documentation
TODO: TBU
TODO: TBU
Style Guide Referrence https://basarat.gitbook.io/typescript/styleguide
TODO: update source tree here