neex 0.7.4 → 0.7.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.
Files changed (2) hide show
  1. package/README.md +53 -30
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  </picture>
8
8
  </a>
9
9
 
10
- # Neex v0.7.4
10
+ # Neex v0.7.6
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
 
@@ -199,28 +199,6 @@ neex p -q "npm run step1" "npm run step2"
199
199
 
200
200
 
201
201
 
202
- 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.
203
-
204
- ```json
205
- {
206
- "scripts": {
207
- "dev": "neex p dev:client dev:server",
208
- "dev:client": "cd apps/client && npm run dev",
209
- "dev:server": "cd apps/server && npm run dev",
210
- "build": "neex s prisma:generate prisma:migrate build:client build:server",
211
- "build:client": "cd apps/client && npm run build",
212
- "build:server": "cd apps/server && npm run build",
213
- "start": "neex p start:client start:server",
214
- "start:client": "cd apps/client && npm run start",
215
- "start:server": "cd apps/server && npm run start",
216
- "prisma:generate": "cd apps/server && npx prisma generate",
217
- "prisma:migrate": "cd apps/server && npx prisma db push"
218
- }
219
- }
220
- ```
221
-
222
-
223
-
224
202
  ## 📂 Project Structure
225
203
 
226
204
  Neex creates a polyrepo-in-monorepo structure for clear separation and scalability:
@@ -304,10 +282,13 @@ neex start dist/server.js --max-memory 1G
304
282
 
305
283
 
306
284
 
307
-
308
285
  ## 💡 Real-World Scenarios
309
286
 
310
- 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:
311
292
 
312
293
  ```json
313
294
  {
@@ -319,15 +300,57 @@ Integrate Neex into your `package.json` for a seamless workflow:
319
300
  }
320
301
  ```
321
302
 
322
- 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 => Neex
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**:
323
336
 
324
337
  ```bash
325
- npm run dev # Start development server with live-reloading
326
- npm run build # Compile TypeScript project for production
327
- 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
328
341
  ```
329
342
 
330
- 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
+
331
354
 
332
355
  ## 📋 System Requirements
333
356
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "neex",
3
- "version": "0.7.4",
3
+ "version": "0.7.6",
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",
@@ -60,7 +60,7 @@
60
60
  "typescript": "^4.9.3"
61
61
  },
62
62
  "engines": {
63
- "node": ">=20.0.0"
63
+ "node": ">=18.0.0"
64
64
  },
65
65
  "repository": {
66
66
  "type": "git",