Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
DouglasdeMoura committed Sep 3, 2024
1 parent 416b0b2 commit ecb1d48
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit ecb1d48

Please sign in to comment.