Skip to content

Commit cec0ccd

Browse files
committed
docs(readme): add README.md
1 parent 09ffde7 commit cec0ccd

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# fastify-esbuild
2+
3+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
4+
5+
---
6+
7+
Opinionated boilerplate to build a Fastify app with a better DX.
8+
9+
## Features
10+
11+
- Use `nodemon` & `esbuild-node-tsc` during devlopment to reduce feedback loop.
12+
- Use `esbuild` to bundle & minify production code.
13+
- Use Conventional Commits & SemVer standards, e.g. `commitlint`, `commitizen`, `standard-version`.
14+
- Use `eslint`, `prettier`, `lint-staged`.
15+
- Use `husky` git hooks helper to run formatter & linter.
16+
17+
---
18+
19+
## How to start?
20+
21+
```zsh
22+
# Install dependencies
23+
pnpm i
24+
25+
# Activate git hooks
26+
pnpm prepare
27+
28+
# Start development
29+
pnpm dev
30+
31+
# Build production code
32+
pnpm build
33+
34+
# Run production code
35+
node build
36+
37+
# New commit with interactive CLI
38+
pnpm cz
39+
40+
# Auto generate changelogs and versioning
41+
pnpm release
42+
```
43+
44+
## TODO
45+
46+
- [ ] Add `vitest` & `msw`
47+
- [ ] Add `dotnev` for different stages
48+
- [ ] Add `mongodb` examples
49+
- [ ] Add `docker` or `docker-compose` for deployment
50+
- [ ] Add `envoy` as a sidecar proxy

0 commit comments

Comments
 (0)