micro-service-maker 1.1.5 → 1.1.6
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 +18 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
This monorepo serves as the main entry point and controller for all microservices under a single gateway. It uses TypeScript, Express, and custom tooling to streamline development.
|
|
4
4
|
|
|
5
|
+
|
|
5
6
|
---
|
|
6
7
|
|
|
7
8
|
## 📁 Project Structure
|
|
@@ -22,6 +23,21 @@ microservice/
|
|
|
22
23
|
|
|
23
24
|
---
|
|
24
25
|
|
|
26
|
+
## Recommended:
|
|
27
|
+
To avoid configuration mistakes and save setup time, it is recommended to clone the ready-made repository from the link below instead of creating the project structure manually.
|
|
28
|
+
|
|
29
|
+
🔗 [Repo link-](https://github.com/sharmasatyam121104-devloper/micro-service-structure)
|
|
30
|
+
|
|
31
|
+
After cloning this repository to your system, run the following command in the root directory to install the micro-service-maker package:
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
npm install micro-service-maker
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
⬇️ After this section, you can continue with the next process or steps as required.
|
|
40
|
+
|
|
25
41
|
## 📦 Scripts
|
|
26
42
|
|
|
27
43
|
| Command | Description |
|
|
@@ -40,7 +56,7 @@ microservice/
|
|
|
40
56
|
- **TypeScript**
|
|
41
57
|
- **Mongoose**
|
|
42
58
|
- **ts-node-dev**
|
|
43
|
-
- **
|
|
59
|
+
- **msm (Service Generator)**
|
|
44
60
|
|
|
45
61
|
---
|
|
46
62
|
|
|
@@ -49,7 +65,7 @@ microservice/
|
|
|
49
65
|
To scaffold a new microservice:
|
|
50
66
|
|
|
51
67
|
```bash
|
|
52
|
-
npx
|
|
68
|
+
npx msm
|
|
53
69
|
```
|
|
54
70
|
|
|
55
71
|
👉 Then type the desired **service name** when prompted.
|