The aim of this repository is to provide a concrete example of a Fastify application using what are considered best practices by the Fastify community.

Prerequisites: You need to have Node.js version 22 or higher installed.

This demo is a simple task management API. It allows users to create, retrieve, update, and delete tasks. Additional features include file uploads, CSV downloads, task assignment, and role-based access control.

Install the dependencies:

npm install

Create a .env file based on .env.example and update values as needed.

Make sure COOKIE_SECRET is set to a secret with at least 32 characters.

You can run a MySQL instance with Docker:

docker compose up

To run it in the background:

docker compose up -d

To create the database, run:

npm run db:create

To create and update the database schema, run the migrations:

npm run db:migrate

To populate the database with initial data, run:

npm run db:seed

To drop the database, run:

npm run db:drop

To build the project:

npm run build

In dev mode:

npm run dev

Open http://localhost:3000 to view it in the browser.

In production mode:

npm run start

The application exposes interactive API documentation using Swagger UI.

Once the server is running, visit: http://localhost:3000/api/docs

To run the tests:

npm run test

dev and start leverage fastify-cli, but you can run the demo as a standalone executable (see server.ts):

npm run standalone

To check for linting errors:

npm run lint

To check and automatically fix linting errors:

npm run lint:fix

To learn more about Fastify, check out the Fastify documentation.