Skip to content

Commit

Permalink
docs(readme): add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wd-David committed Apr 24, 2022
1 parent 09ffde7 commit cec0ccd
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# fastify-esbuild

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

---

Opinionated boilerplate to build a Fastify app with a better DX.

## Features

- Use `nodemon` & `esbuild-node-tsc` during devlopment to reduce feedback loop.
- Use `esbuild` to bundle & minify production code.
- Use Conventional Commits & SemVer standards, e.g. `commitlint`, `commitizen`, `standard-version`.
- Use `eslint`, `prettier`, `lint-staged`.
- Use `husky` git hooks helper to run formatter & linter.

---

## How to start?

```zsh
# Install dependencies
pnpm i

# Activate git hooks
pnpm prepare

# Start development
pnpm dev

# Build production code
pnpm build

# Run production code
node build

# New commit with interactive CLI
pnpm cz

# Auto generate changelogs and versioning
pnpm release
```

## TODO

- [ ] Add `vitest` & `msw`
- [ ] Add `dotnev` for different stages
- [ ] Add `mongodb` examples
- [ ] Add `docker` or `docker-compose` for deployment
- [ ] Add `envoy` as a sidecar proxy

0 comments on commit cec0ccd

Please sign in to comment.