UNPKG

@bodheesh/create-bodhi-node-app

Version:

Create a production-ready Node.js REST API with zero configuration

132 lines (107 loc) ā€¢ 3.5 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# @bodhi/crud-api-generator A powerful CLI tool that generates Express.js REST APIs or GraphQL endpoints from a simple JSON schema. ## Features - šŸš€ Instant API generation from JSON schema - šŸ’¾ Support for MongoDB, PostgreSQL, and Firebase - šŸ”„ Auto-generated CRUD operations - šŸ“š Swagger documentation generation - āš” GraphQL support - šŸŽÆ Clean and maintainable code generation ## Installation ```bash npm install -g @bodhi/crud-api-generator ``` ## Usage 1. Create a JSON schema file (e.g., `schema.json`): ```json { "name": "User", "fields": { "name": { "type": "String", "required": true }, "email": { "type": "String", "required": true, "unique": true }, "age": { "type": "Number" } } } ``` 2. Generate the API: ```bash bodhi-crud generate -s schema.json -d mongodb -t rest ``` Options: - `-s, --schema`: Path to JSON schema file (required) - `-d, --database`: Database type (mongodb, postgres, firebase) (default: mongodb) - `-t, --type`: API type (rest, graphql) (default: rest) - `-o, --output`: Output directory (default: ./generated) ## Generated Structure The tool will generate the following files: ``` generated/ ā”œā”€ā”€ models/ ā”‚ ā””ā”€ā”€ user.model.js ā”œā”€ā”€ controllers/ ā”‚ ā””ā”€ā”€ user.controller.js ā”œā”€ā”€ routes/ ā”‚ ā””ā”€ā”€ user.routes.js ā””ā”€ā”€ swagger.json ``` ## Database Support ### MongoDB - Uses Mongoose for schema definition and validation - Generates complete CRUD operations - Includes pagination and filtering ### PostgreSQL (Coming Soon) - Sequelize ORM integration - Migration generation - Complex queries support ### Firebase (Coming Soon) - Firestore integration - Real-time updates - Security rules generation ## Contributing Contributions are welcome! Please feel free to submit a Pull Request. ## License MIT šŸ“¦ rest-api ā”£ šŸ“‚ src ā”ƒ ā”£ šŸ“‚ config ā”ƒ ā”ƒ ā”£ šŸ“„ index.js # Central configuration ā”ƒ ā”ƒ ā”— šŸ“„ swagger.js # Swagger/OpenAPI configuration ā”ƒ ā”£ šŸ“‚ controllers ā”ƒ ā”ƒ ā”£ šŸ“‚ auth ā”ƒ ā”ƒ ā”ƒ ā”— šŸ“„ auth.controller.js # Authentication controller ā”ƒ ā”ƒ ā”— šŸ“‚ user ā”ƒ ā”ƒ ā”— šŸ“„ user.controller.js # User management controller ā”ƒ ā”£ šŸ“‚ middleware ā”ƒ ā”ƒ ā”£ šŸ“„ error.middleware.js # Global error handler ā”ƒ ā”ƒ ā”— šŸ“‚ validation ā”ƒ ā”ƒ ā”£ šŸ“„ auth.middleware.js # JWT authentication ā”ƒ ā”ƒ ā”£ šŸ“„ auth.validation.js # Auth input validation ā”ƒ ā”ƒ ā”£ šŸ“„ role.middleware.js # Role-based access control ā”ƒ ā”ƒ ā”— šŸ“„ user.validation.js # User input validation ā”ƒ ā”£ šŸ“‚ models ā”ƒ ā”ƒ ā”— šŸ“„ user.model.js # User model schema ā”ƒ ā”£ šŸ“‚ routes ā”ƒ ā”ƒ ā”£ šŸ“‚ auth ā”ƒ ā”ƒ ā”ƒ ā”— šŸ“„ auth.routes.js # Auth routes ā”ƒ ā”ƒ ā”— šŸ“‚ user ā”ƒ ā”ƒ ā”— šŸ“„ user.routes.js # User routes ā”ƒ ā”£ šŸ“‚ utils ā”ƒ ā”ƒ ā”£ šŸ“„ db.util.js # Database utilities ā”ƒ ā”ƒ ā”£ šŸ“„ error.util.js # Error classes ā”ƒ ā”ƒ ā”£ šŸ“„ logger.util.js # Logging utility ā”ƒ ā”ƒ ā”— šŸ“„ response.util.js # Response formatter ā”ƒ ā”— šŸ“„ index.js # Application entry point ā”£ šŸ“‚ logs # Log files directory ā”£ šŸ“„ .env.example # Environment variables example ā”£ šŸ“„ .gitignore # Git ignore file ā”£ šŸ“„ package.json # Project dependencies ā”— šŸ“„ README.md # Project documentation