UNPKG

archgenie

Version:

A powerful Node.js CLI tool to quickly scaffold project folder structures based on popular software architecture patterns.

116 lines (83 loc) • 2.12 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# ArchGenie CLI A powerful Node.js CLI tool to quickly scaffold project folder structures based on popular software architecture patterns. --- ## Features - Supports multiple architecture patterns like MVC, MVP, MVVM, PAC, HMVC, Layered, Microservices, Serverless, Clean Architecture, Hexagonal, Onion, REST, GraphQL, gRPC, Event-Driven, CQRS, Pub/Sub, Client-Server, P2P, and more. - Easily switch between architectures with a simple command. - Automatically initializes git repo, npm project, installs Express and Nodemon. - Option to backup or delete existing project files before scaffolding a new structure. - Helps enforce clean project organization for better maintainability. --- ## Installation ```bash npm install -g archgenie ``` --- ## Usage ```bash archgenie@create <architecture-flag> ``` ## Help ```bash archgenie@create --help ``` ### Available Flags ``` --mvc --mvp --mvvm --pac --hmvc --layered --monolithic --microservices --soa --serverless --clean --hexagonal --onion --rest --graphql --grpc --event_driven --cqrs --pub_sub --client_server --p2p --master_slave --leader_follower --load_balanced_cluster --blackboard --pipes_filters --microkernel --service_mesh --reactive --help --version ``` --- ## Examples ```bash archgen-cli --mvc ``` Creates folders for the MVC pattern including models, views, controllers, and related folders. --- ## How it works - Checks if a previous architecture was scaffolded. - Prompts you to delete existing files or back them up before creating the new folder structure. - Initializes git and npm, installs dependencies (`express` and `nodemon`). - Creates folders and adds basic `.gitignore` and `server.js` files. --- ## Version `1.1.3` --- ## Author Praveen KR Email: [coder.praveenkr@gmail.com](mailto:coder.praveenkr@gmail.com) LinkedIn: [https://www.linkedin.com/in/mepraveenkr/](https://www.linkedin.com/in/mepraveenkr/) GitHub: [https://github.com/frontenddeveloperpraveen](https://github.com/frontenddeveloperpraveen) --- ## License MIT License --- Feel free to contribute, raise issues, or request new architectures!