@erwininteractive/mvc 0.2.0 → 0.3.0

package/README.md

@@ -110,9 +110,55 @@ app.get("/api/users", (req, res) => {
 
 ---
 
+## Resources
+
+Generate a complete resource (model + controller + views) with one command:
+
+```bash
+npx erwinmvc generate resource Post
+```
+
+This creates:
+- `prisma/schema.prisma` - Adds the Post model
+- `src/controllers/PostController.ts` - Full CRUD controller with form handling
+- `src/views/posts/index.ejs` - List view
+- `src/views/posts/show.ejs` - Detail view
+- `src/views/posts/create.ejs` - Create form
+- `src/views/posts/edit.ejs` - Edit form
+
+### Resource Routes
+
+| Action    | HTTP Method | URL              | Description      |
+|-----------|-------------|------------------|------------------|
+| `index`   | GET         | /posts           | List all         |
+| `create`  | GET         | /posts/create    | Show create form |
+| `store`   | POST        | /posts           | Create new       |
+| `show`    | GET         | /posts/:id       | Show one         |
+| `edit`    | GET         | /posts/:id/edit  | Show edit form   |
+| `update`  | PUT         | /posts/:id       | Update           |
+| `destroy` | DELETE      | /posts/:id       | Delete           |
+
+### Wiring Up Routes
+
+Add to `src/server.ts`:
+
+```typescript
+import * as PostController from "./controllers/PostController";
+
+app.get("/posts", PostController.index);
+app.get("/posts/create", PostController.create);
+app.post("/posts", PostController.store);
+app.get("/posts/:id", PostController.show);
+app.get("/posts/:id/edit", PostController.edit);
+app.put("/posts/:id", PostController.update);
+app.delete("/posts/:id", PostController.destroy);
+```
+
+---
+
 ## Controllers
 
-Generate a controller with the CLI:
+Generate just a controller (without model/views):
 
 ```bash
 npx erwinmvc generate controller Product
@@ -239,6 +285,7 @@ app.get("/protected", authenticate, (req, res) => {
 | Command | Description |
 |---------|-------------|
 | `npx @erwininteractive/mvc init <dir>` | Create a new app |
+| `npx erwinmvc generate resource <name>` | Generate model + controller + views |
 | `npx erwinmvc generate controller <name>` | Generate a CRUD controller |
 | `npx erwinmvc generate model <name>` | Generate a database model |
 
@@ -248,8 +295,19 @@ app.get("/protected", authenticate, (req, res) => {
 |--------|-------------|
 | `--skip-install` | Skip running npm install |
 | `--with-database` | Include Prisma database setup |
+| `--with-ci` | Include GitHub Actions CI workflow |
 
-### Generate Options
+### Resource Options
+
+| Option | Description |
+|--------|-------------|
+| `--skip-model` | Skip generating Prisma model |
+| `--skip-controller` | Skip generating controller |
+| `--skip-views` | Skip generating views |
+| `--skip-migrate` | Skip running Prisma migrate |
+| `--api-only` | Generate API-only controller (no views) |
+
+### Other Generate Options
 
 | Option | Description |
 |--------|-------------|
@@ -299,6 +357,121 @@ public/images/logo.png  →  /images/logo.png
 
 ---
 
+## CI/CD (Optional)
+
+Add GitHub Actions CI to your project for automated testing:
+
+```bash
+npx @erwininteractive/mvc init myapp --with-ci
+```
+
+Or add CI to an existing project by creating `.github/workflows/test.yml`:
+
+```yaml
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: Build
+        run: npm run build
+```
+
+### Adding Database Tests
+
+If your app uses a database, add PostgreSQL as a service:
+
+```yaml
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run migrations
+        run: npx prisma migrate deploy
+        env:
+          DATABASE_URL: postgresql://postgres:postgres@localhost:5432/test
+
+      - name: Run tests
+        run: npm test
+        env:
+          DATABASE_URL: postgresql://postgres:postgres@localhost:5432/test
+
+      - name: Build
+        run: npm run build
+```
+
+### Secrets
+
+For production deployments, add these secrets in your GitHub repository settings:
+
+| Secret | Description |
+|--------|-------------|
+| `DATABASE_URL` | Production database connection string |
+| `REDIS_URL` | Production Redis connection string |
+| `JWT_SECRET` | Secret key for JWT signing |
+| `SESSION_SECRET` | Secret key for session encryption |
+
+Access secrets in your workflow:
+
+```yaml
+env:
+  DATABASE_URL: ${{ secrets.DATABASE_URL }}
+  JWT_SECRET: ${{ secrets.JWT_SECRET }}
+```
+
+---
+
 ## Environment Variables
 
 All optional. Create `.env` from `.env.example`:

package/dist/cli.js

@@ -10,13 +10,14 @@ const program = new commander_1.Command();
 program
     .name("erwinmvc")
     .description("CLI for @erwininteractive/mvc framework")
-    .version("0.1.5");
+    .version("0.2.0");
 // Init command - scaffold a new application
 program
     .command("init <dir>")
     .description("Scaffold a new MVC application")
     .option("--skip-install", "Skip npm install")
     .option("--with-database", "Include database/Prisma setup")
+    .option("--with-ci", "Include GitHub Actions CI workflow")
     .action(async (dir, options) => {
     try {
         await (0, initApp_1.initApp)(dir, options);

package/dist/generators/initApp.d.ts

@@ -1,6 +1,7 @@
 export interface InitOptions {
     skipInstall?: boolean;
     withDatabase?: boolean;
+    withCi?: boolean;
 }
 /**
  * Scaffold a new MVC application.

package/dist/generators/initApp.js

@@ -68,6 +68,10 @@ async function initApp(dir, options = {}) {
     if (options.withDatabase) {
         setupDatabase(targetDir);
     }
+    // Setup CI if requested
+    if (options.withCi) {
+        setupCi(targetDir);
+    }
     console.log(`
 Next steps:
   cd ${dir}
@@ -81,6 +85,19 @@ To add database support later:
   npx prisma migrate dev --name init
 ` : ""}`);
 }
+/**
+ * Setup GitHub Actions CI workflow.
+ */
+function setupCi(targetDir) {
+    const workflowDir = path_1.default.join(targetDir, ".github", "workflows");
+    fs_1.default.mkdirSync(workflowDir, { recursive: true });
+    const ciTemplateDir = path_1.default.join((0, paths_1.getTemplatesDir)(), "ci");
+    const testWorkflow = path_1.default.join(ciTemplateDir, "test.yml");
+    if (fs_1.default.existsSync(testWorkflow)) {
+        fs_1.default.copyFileSync(testWorkflow, path_1.default.join(workflowDir, "test.yml"));
+        console.log("GitHub Actions CI workflow added.");
+    }
+}
 /**
  * Setup Prisma database support.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erwininteractive/mvc",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A lightweight, full-featured MVC framework for Node.js with Express, Prisma, and EJS",
   "main": "dist/framework/index.js",
   "types": "dist/framework/index.d.ts",

package/templates/ci/test.yml

@@ -0,0 +1,49 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    # Uncomment to add PostgreSQL for database tests
+    # services:
+    #   postgres:
+    #     image: postgres:16
+    #     env:
+    #       POSTGRES_USER: postgres
+    #       POSTGRES_PASSWORD: postgres
+    #       POSTGRES_DB: test
+    #     ports:
+    #       - 5432:5432
+    #     options: >-
+    #       --health-cmd pg_isready
+    #       --health-interval 10s
+    #       --health-timeout 5s
+    #       --health-retries 5
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+        # Uncomment for database tests
+        # env:
+        #   DATABASE_URL: postgresql://postgres:postgres@localhost:5432/test
+
+      - name: Build
+        run: npm run build