Skip to content

Commit c25b4f2

Browse files
committed
update readme
1 parent 57efc84 commit c25b4f2

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

readme.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,21 @@
1313

1414
## Usage
1515

16+
You can create the following project templates:
17+
- http-api server with express
18+
- websocket server with plain websocket
19+
- socket.io server
20+
- a generic npm package for publish etc.
21+
- an empty project with no presets, just the developer dependencies
22+
23+
Every Project can have
24+
- `eslint`, `prettier`, `convict`, `winston`, `joi`, `amqp`, `mqtt` configured
25+
- as well as different test frameworks like `jest`, `mocha`, `cypress`, `vitest` with code coverage via `nyc`
26+
- different database dependencies can be selected: `mongoose`, `typeorm`, `mysql` / `mysql2`, `mongodb`, `redis`
27+
- Dockerfile configuration can be created
28+
- CI/CD templates for `github actions` and `gitlab ci` can be created
29+
30+
1631
### Run:
1732
```shell
1833
npm init typescript-project-scaffolding

0 commit comments

Comments
 (0)