Skip to content

Commit a7bab63

Browse files
committed
docs: add new docs
Signed-off-by: Vitor Hugo Salgado <vsalgadopb@gmail.com>
1 parent fd20ec5 commit a7bab63

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424

2525
## Overview
2626

27-
Starter project for **Node.js** applications using **TypeScript** with Test, Lint, Code Style already configured. Take a
28-
look below for all the tooling available in this repository.
27+
Starter project for **Node.js** applications using **TypeScript** with test, lint, code formatter already configured.
28+
Check the [tooling](#tooling) section for more details.
2929
The preferable way to use this boilerplate is using `npx` command. You can use `npm init` too.
3030
Use the following commands to bootstrap a new project:
3131

@@ -50,17 +50,32 @@ All parameters available:
5050
--app=<APP_NAME> Defaults to my-app
5151
```
5252

53+
## ESM
54+
55+
The project template now uses **ESM** by default.
56+
5357
The final folder will the parameter `destination` concatenated with parameter `app`.
5458

59+
## Docker
60+
61+
Minimalist docker image generation.
62+
Check this [Dockerfile](build/docker/Dockerfile).
63+
64+
## Local Dev Environment
65+
66+
Run `make up` spin up a local environment with **Docker Compose**.
67+
Check this [docker-compose.yml](deployments/dev/docker-compose.yml) for more details.
68+
5569
## Tooling
5670

71+
- ESM
5772
- TypeScript
73+
- Jest
5874
- EsLint
5975
- Husky
6076
- Commit Lint
6177
- Lint Staged
6278
- Prettier
63-
- Standard Version
6479
- Nodemon
6580
- Docker | Docker Compose
6681

0 commit comments

Comments
 (0)