Fastify Serverless Starter

Stack:

• NodeJs
• Fastify
• Serverless Framework
• Tap
• Eslint
• Prettier
• Husky

Commands

Start server

Start local server (use only for development and testing purposes)

npm run dev

Start serverless offline

Start serverless in offline mode (use only for development and testing purposes)

npm run offline

Testing

Launch tests

npm run test

Launch tests with coverage

npm run test:coverage

Launch tests with filter

npm run test:filter --filter=<filter>

Linting and Formatting

Check linting

npm run lint

Fix linting

npm run lint:fix

Format code

npm run format

Install Pre-commit hook

npm run precommit:init

then copy the content of pre-commit-dist into .husky/pre-commit

Use Cases

Health Check

curl --location 'https://<app-url>/api/health/'

should return

{
  "status": "ok"
}

Swagger

You can find the swagger documentation at the following url:

https://<app-url>/api/documentation