neex 0.7.3 → 0.7.5

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.
Files changed (2) hide show
  1. package/README.md +55 -47
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  </picture>
8
8
  </a>
9
9
 
10
- # Neex v0.7.3
10
+ # Neex v0.7.5
11
11
 
12
12
  ### Neex - Modern Fullstack Framework Built on Express and Next.js. Fast to Start, Easy to Build, Ready to Deploy.
13
13
 
@@ -158,25 +158,6 @@ neex start dist/server.js --health-port 3001
158
158
  ```
159
159
 
160
160
 
161
- Below is an example of `package.json` scripts for running two projects (frontend and backend) concurrently, along with ORM (Prisma) integration, tailored for a Neex project with a polyrepo-in-monorepo architecture. This example demonstrates how to use Neex commands to manage development, building, and production workflows efficiently.
162
-
163
- ```json
164
- {
165
- "scripts": {
166
- "dev": "neex p dev:client dev:server",
167
- "dev:client": "cd apps/client && bun run dev",
168
- "dev:server": "cd apps/server && bun run dev",
169
- "build": "neex s prisma:generate prisma:migrate build:client build:server",
170
- "build:client": "cd apps/client && bun run build",
171
- "build:server": "cd apps/server && bun run build",
172
- "start": "neex p start:client start:server",
173
- "start:client": "cd apps/client && bun run start",
174
- "start:server": "cd apps/server && bun run start",
175
- "prisma:generate": "cd apps/server && bunx prisma generate",
176
- "prisma:migrate": "cd apps/server && bunx prisma db push"
177
- }
178
- }
179
- ```
180
161
 
181
162
  ### Explanation of Scripts
182
163
 
@@ -200,26 +181,6 @@ npm run build # Sequentially generates Prisma client, applies migrations,
200
181
  npm run start # Starts frontend and backend in production mode concurrently
201
182
  ```
202
183
 
203
- Below is an example of `package.json` scripts for running two projects (frontend and backend) concurrently, along with ORM (Prisma) integration, tailored for a Neex project. This example demonstrates how to use Neex commands to manage development, building, and production workflows efficiently.
204
-
205
- ```json
206
- {
207
- "scripts": {
208
- "dev": "neex p dev:client dev:server",
209
- "dev:client": "cd apps/client && bun run dev",
210
- "dev:server": "cd apps/server && bun run dev",
211
- "build": "neex s prisma:generate prisma:migrate build:client build:server",
212
- "build:client": "cd apps/client && bun run build",
213
- "build:server": "cd apps/server && bun run build",
214
- "start": "neex p start:client start:server",
215
- "start:client": "cd apps/client && bun run start",
216
- "start:server": "cd apps/server && bun run start",
217
- "prisma:generate": "cd apps/server && bunx prisma generate",
218
- "prisma:migrate": "cd apps/server && bunx prisma db push"
219
- }
220
- }
221
- ```
222
-
223
184
 
224
185
  #### Parallel and Sequential Execution
225
186
 
@@ -236,6 +197,8 @@ neex s "npm run clean" "npm run build" "npm run deploy"
236
197
  neex p -q "npm run step1" "npm run step2"
237
198
  ```
238
199
 
200
+
201
+
239
202
  ## 📂 Project Structure
240
203
 
241
204
  Neex creates a polyrepo-in-monorepo structure for clear separation and scalability:
@@ -319,10 +282,13 @@ neex start dist/server.js --max-memory 1G
319
282
 
320
283
 
321
284
 
322
-
323
285
  ## 💡 Real-World Scenarios
324
286
 
325
- Integrate Neex into your `package.json` for a seamless workflow:
287
+ Integrate Neex into your `package.json` to streamline development, building, and deployment workflows for your fullstack projects. Whether you're working with an **Express-only backend** or a combined **Express + Next.js** application, Neex’s powerful CLI and monorepo architecture make it easy to manage your projects efficiently.
288
+
289
+ ### Example 1: Express-Only Project
290
+
291
+ For a standalone Express backend, configure your `package.json` with minimal yet powerful scripts to handle development, building, and production:
326
292
 
327
293
  ```json
328
294
  {
@@ -334,15 +300,57 @@ Integrate Neex into your `package.json` for a seamless workflow:
334
300
  }
335
301
  ```
336
302
 
337
- Run scripts with:
303
+ **Run your scripts**:
304
+
305
+ ```bash
306
+ npm run dev # Starts the Express development server with live-reloading
307
+ npm run build # Compiles TypeScript to production-ready JavaScript
308
+ npm run start # Launches the Express server in production mode
309
+ ```
310
+
311
+ This setup provides a clean, efficient workflow for Express-based projects, leveraging Neex’s live-reloading and production-ready features for rapid development and deployment.
312
+
313
+ ### Example 2: Fullstack Express + Next.js Project
314
+
315
+ For a fullstack application with a **Next.js frontend** and an **Express backend**, Neex’s polyrepo-in-monorepo architecture shines. The following `package.json` example demonstrates how to manage both projects concurrently, with integrated Prisma ORM for database operations:
316
+
317
+ ```json
318
+ {
319
+ "scripts": {
320
+ "dev": "neex p dev:client dev:server",
321
+ "dev:client": "cd apps/client && npm run dev",
322
+ "dev:server": "cd apps/server && npm run dev",
323
+ "build": "neex s prisma:generate prisma:migrate build:client build:server",
324
+ "build:client": "cd apps/client && npm run build",
325
+ "build:server": "cd apps/server && npm run build",
326
+ "start": "neex p start:client start:server",
327
+ "start:client": "cd apps/client && npm run start",
328
+ "start:server": "cd apps/server && npm run start",
329
+ "prisma:generate": "cd apps/server && npx prisma generate",
330
+ "prisma:migrate": "cd apps/server && npx prisma db push"
331
+ }
332
+ }
333
+ ```
334
+
335
+ **Run your scripts**:
338
336
 
339
337
  ```bash
340
- npm run dev # Start development server with live-reloading
341
- npm run build # Compile TypeScript project for production
342
- npm run start # Start production server
338
+ npm run dev # Starts Next.js frontend and Express backend in parallel with live-reloading
339
+ npm run build # Sequentially generates Prisma client, applies migrations, and builds both projects
340
+ npm run start # Launches frontend and backend in production mode concurrently
343
341
  ```
344
342
 
345
- This configuration provides a minimal yet effective setup for developing, building, and deploying your Neex project. The `dev` command runs a TypeScript development server, `build` compiles the project, and `start` launches the production application.
343
+ ### Why It Works
344
+
345
+ - **Parallel Execution**: Use `neex p` to run frontend and backend tasks simultaneously, ensuring efficient development and production workflows.
346
+ - **Sequential Execution**: Use `neex s` for tasks like Prisma migrations and builds, ensuring dependencies are handled in the correct order.
347
+ - **Modular Architecture**: Neex’s polyrepo-in-monorepo structure keeps frontend and backend codebases independent yet unified, making it easy to scale or extract projects.
348
+ - **Prisma Integration**: Streamlined database management with `prisma:generate` and `prisma:migrate` for type-safe, rapid development.
349
+
350
+ This configuration is perfect for developers building fullstack applications with **Next.js**, **Express**, and **Prisma**, offering a seamless, scalable, and maintainable development experience. Start using Neex today to simplify your workflow and build high-performance applications with ease!
351
+
352
+
353
+
346
354
 
347
355
  ## 📋 System Requirements
348
356
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "neex",
3
- "version": "0.7.3",
3
+ "version": "0.7.5",
4
4
  "description": "The Modern Build System for Polyrepo-in-Monorepo Architecture",
5
5
  "main": "dist/src/index.js",
6
6
  "types": "dist/src/index.d.ts",