1# Project Name
2
3One sentence describing what the project does and for whom.
4
5 
6
7## Features
8
9- Feature one
10- Feature two
11
12## Quick start
13
14### Prerequisites
15
16- Docker 24+
17- Node.js 20+
18
19### Run
20
21```bash
22git clone https://github.com/<user>/<repo>.git
23cd <repo>
24cp .env.example .env
25docker compose up -d
26```
27
28Open <http://localhost:3000>.
29
30## Usage
31
32```bash
33curl http://localhost:3000/api/health
34```
35
36## Configuration
37
38| Variable | Default | Description |
39|---------------|---------|-----------------------|
40| `PORT` | `3000` | HTTP port |
41| `DATABASE_URL`| – | Postgres connection |
42
43## Project structure
44
45```text
46src/ application code
47docs/ extra documentation
48tests/ automated tests
49```
50
51## Testing
52
53```bash
54npm test
55```
56
57## Contributing
58
59See [CONTRIBUTING.md](CONTRIBUTING.md).
60
61## License
62
63[MIT](LICENSE)