From ecb1d48606f92c2c28fa5b8ccc0c96c7bcc53d1b Mon Sep 17 00:00:00 2001 From: Douglas Moura Date: Tue, 3 Sep 2024 09:58:04 -0300 Subject: [PATCH] chore: update README --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad9b857..d3b3446 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,23 @@ -# Getting Started with [Fastify-CLI](https://www.npmjs.com/package/fastify-cli) - -This project was bootstrapped with Fastify-CLI. Use this template to start your Fastify project. +# Fastify TypeScript starter + +This is a Fastify starter project for your new projects. Out-of-the-box, it includes: + +- TypeScript (with [tsx](https://www.npmjs.com/package/tsx) for development); +- OpenAPI support with [Scalar](https://github.com/scalar/scalar/blob/main/packages/fastify-api-reference/README.md) theme; +- File based routing and auto-loading plugins provided by [fastify-autoload](https://github.com/fastify/fastify-autoload); +- GitHub Actions for auto-merging Dependabot PRs, running tests, building the project and validate the Dockerfile; +- VS Code settings for debugging and formatting; +- [Vitest](https://vitest.dev/) for testing; +- [Biome](https://biomejs.dev) for code formatting and linting; +- [Commitlint](https://commitlint.js.org/) for commit message linting; +- [Lefthook](https://github.com/evilmartians/lefthook) for git hooks; +- [Docker](https://www.docker.com/) for containerization; +- [Docker Compose](https://docs.docker.com/compose/) for running the app in a container; +- [Release It!](https://www.npmjs.com/package/release-it) to automate versioning and package publishing-related tasks (by default, the versioning is done following [CalVer](https://calver.org/) format). + +## Getting Started + +Use this template to start your Fastify project. ```bash npx degit DouglasdeMoura/fastify-ts-starter my-fastify-app