express-modular-monolith 1.1.3 → 1.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,14 +1,52 @@
|
|
|
1
1
|
# Express Modular Monolith
|
|
2
2
|
|
|
3
|
-
Generate an Express modular monolith boilerplate.
|
|
3
|
+
Generate an Express modular monolith boilerplate with JavaScript or TypeScript.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
|
+
|
|
6
7
|
```bash
|
|
7
8
|
npx express-modular-monolith
|
|
8
9
|
```
|
|
10
|
+
|
|
9
11
|
## Features
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
* JavaScript template
|
|
14
|
+
* TypeScript template
|
|
15
|
+
* Modular monolith structure
|
|
16
|
+
* Express
|
|
17
|
+
* Automatic Git repository initialization
|
|
18
|
+
* Automatic initial Git commit
|
|
19
|
+
|
|
20
|
+
## What's New in v1.1.4
|
|
21
|
+
|
|
22
|
+
* Added automatic `git init` after generating the project
|
|
23
|
+
* Added automatic initial commit for the generated boilerplate
|
|
24
|
+
* The generated project is ready to start tracking with Git immediately
|
|
25
|
+
|
|
26
|
+
## How It Works
|
|
27
|
+
|
|
28
|
+
Run:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npx express-modular-monolith
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Choose your preferred language and project location. The CLI will:
|
|
35
|
+
|
|
36
|
+
1. Generate the selected boilerplate
|
|
37
|
+
2. Install the required dependencies
|
|
38
|
+
3. Initialize a Git repository
|
|
39
|
+
4. Add the generated files to Git
|
|
40
|
+
5. Create an initial commit
|
|
41
|
+
|
|
42
|
+
Your generated project will be ready for development with Git already configured.
|
|
43
|
+
|
|
44
|
+
## Requirements
|
|
45
|
+
|
|
46
|
+
* Node.js
|
|
47
|
+
* npm
|
|
48
|
+
* Git
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT
|