nitronjs 0.1.0

package/README.md

@@ -0,0 +1,429 @@
+# NitronJS
+
+A modern and extensible Node.js MVC framework built on Fastify. NitronJS focuses on clean architecture, modular structure, and developer productivity, offering built-in routing, middleware, configuration management, CLI tooling, and native React integration for scalable full-stack applications.
+
+## Features
+
+- **MVC Architecture** - Clean separation of concerns with Models, Views, and Controllers
+- **React SSR** - Built-in React server-side rendering with TypeScript support
+- **Fast & Lightweight** - Built on Fastify for high performance
+- **CLI Tools** - Powerful command-line interface for scaffolding and development
+- **Database ORM** - Intuitive query builder and model system for MySQL
+- **Hot Reload** - Development mode with automatic reloading
+- **Middleware System** - Flexible middleware pipeline with route-specific middleware
+- **Session Management** - Built-in session support with multiple drivers
+- **Security** - CSRF protection, authentication, and input validation
+- **Modern Build System** - esbuild + PostCSS + Tailwind CSS integration
+
+## Installation
+
+Create a new NitronJS project:
+
+```bash
+npx nitronjs my-app
+cd my-app
+```
+
+Dependencies are installed automatically during project creation.
+
+## Quick Start
+
+1. **Configure your database** in `config/database.js`
+
+2. **Run migrations**:
+```bash
+npx njs migrate --seed
+```
+
+3. **Start development server**:
+```bash
+npm run dev
+```
+
+Your application will be running at `http://localhost:3000`
+
+## CLI Commands
+
+NitronJS comes with a powerful CLI tool (`njs`):
+
+### Development & Build
+```bash
+njs dev           # Start development server with hot reload
+njs build         # Build views for production
+njs start         # Start production server
+```
+
+### Database
+```bash
+njs migrate              # Run pending migrations
+njs migrate:fresh        # Drop all tables and re-run migrations
+njs migrate:fresh --seed # Drop, migrate, and seed
+njs seed                 # Run database seeders
+```
+
+### Code Generation
+```bash
+njs make:controller <name>    # Generate a new controller
+njs make:model <name>          # Generate a new model
+njs make:middleware <name>     # Generate a new middleware
+njs make:migration <name>      # Generate a new migration
+njs make:seeder <name>         # Generate a new seeder
+```
+
+### Utilities
+```bash
+njs storage:link    # Create symbolic link for storage
+```
+
+## Project Structure
+
+```
+my-app/
+├── app/
+│   ├── Controllers/       # Request handlers
+│   ├── Middlewares/       # Custom middleware
+│   └── Models/           # Database models
+├── config/               # Configuration files
+│   ├── app.js
+│   ├── database.js
+│   └── server.js
+├── database/
+│   ├── migrations/       # Database migrations
+│   └── seeders/         # Database seeders
+├── public/              # Static assets
+├── resources/
+│   ├── css/            # Stylesheets
+│   └── views/          # React components (TSX)
+├── routes/
+│   └── web.js          # Route definitions
+└── storage/            # File storage
+```
+
+## Routing
+
+Define routes in `routes/web.js`:
+
+```javascript
+import { Route } from 'nitronjs';
+import HomeController from '#app/Controllers/HomeController.js';
+
+Route.get('/', HomeController.index).name('home');
+Route.get('/about', HomeController.about);
+Route.post('/contact', HomeController.contact);
+```
+
+### Route Groups & Middleware
+
+```javascript
+Route.prefix('/admin').middleware('auth').group(() => {
+    Route.get('/dashboard', AdminController.dashboard);
+    Route.get('/users', AdminController.users);
+});
+```
+
+## Controllers
+
+Create controllers with `njs make:controller`:
+
+```javascript
+class HomeController {
+    static async index(request, reply) {
+        return reply.view('Site/Home', { 
+            title: 'Welcome' 
+        });
+    }
+    
+    static async contact(request, reply) {
+        const { name, email } = request.body;
+        // Handle contact form
+        return reply.redirect('/thank-you');
+    }
+}
+
+export default HomeController;
+```
+
+## Views (React SSR)
+
+Create React views in `resources/views/`:
+
+```tsx
+// resources/views/Site/Home.tsx
+export default function Home({ title, items }) {
+    return (
+        <html>
+            <head>
+                <title>{title}</title>
+                <link rel="stylesheet" href="/css/site_style.css" />
+            </head>
+            <body>
+                <h1>{title}</h1>
+                <ul>
+                    {items.map(item => (
+                        <li key={item.id}>{item.name}</li>
+                    ))}
+                </ul>
+            </body>
+        </html>
+    );
+}
+```
+
+Views are automatically compiled and bundled with your application.
+
+## Models
+
+Create models with `njs make:model`:
+
+```javascript
+import { Model } from 'nitronjs';
+
+export default class User extends Model {
+    static table = 'users';
+    static primaryKey = 'id';
+}
+```
+
+### Query Examples
+
+```javascript
+// Find all users
+const users = await User.get();
+
+// Find by ID
+const user = await User.find(1);
+
+// Where clauses
+const admins = await User.where('role', '=', 'admin').get();
+
+// Create new record
+const user = new User();
+user.name = 'John';
+user.email = 'john@example.com';
+await user.save();
+
+// Update
+await User.where('id', '=', 1).update({ 
+    name: 'Jane' 
+});
+
+// Delete
+await User.where('id', '=', 1).delete();
+```
+
+## Middleware
+
+Create middleware with `njs make:middleware`:
+
+```javascript
+class CheckAge {
+    static async handler(req, res) {
+        const age = req.query.age;
+        
+        if (age < 18) {
+            return res.status(403).send('Access denied');
+        }
+        
+        // If no return, continues to next middleware/handler
+    }
+}
+
+export default CheckAge;
+```
+
+Register middleware in `app/Kernel.js`:
+
+```javascript
+export default {
+    routeMiddlewares: {
+        "check-age": CheckAge,
+    }
+};
+```
+
+Apply to routes:
+
+```javascript
+Route.middleware('check-age').get('/restricted', Controller.method);
+```
+
+## Database Migrations
+
+Create migrations with `njs make:migration`:
+
+```javascript
+import { Schema } from 'nitronjs';
+
+class CreateUsersTable {
+    static async up() {
+        await Schema.create('users', (table) => {
+            table.id();
+            table.string('name');
+            table.string('email').unique();
+            table.string('password');
+            table.timestamp('created_at');
+            table.timestamp('updated_at').nullable();
+        });
+    }
+    
+    static async down() {
+        await Schema.dropIfExists('users');
+    }
+}
+
+export default CreateUsersTable;
+```
+
+## Configuration
+
+All configuration files are in the `config/` directory:
+
+- **app.js** - Application settings (name, env, debug mode)
+- **database.js** - Database connections
+- **server.js** - Server configuration (port, host, CORS)
+- **session.js** - Session management
+- **auth.js** - Authentication settings
+- **hash.js** - Hashing algorithm configuration
+
+Access config values:
+
+```javascript
+import { Config } from 'nitronjs';
+
+const appName = Config.get('app.name');
+const dbHost = Config.get('database.host');
+```
+
+## Session Management
+
+```javascript
+// Set session data
+req.session.set('user', { id: 1, name: 'John' });
+
+// Get session data
+const user = req.session.get('user');
+
+// Check if session has value
+if (req.session.get('user')) {
+    // User is logged in
+}
+
+// Remove session data
+req.session.set('user', null);
+
+// Get all session data
+const allData = req.session.all();
+
+// Regenerate session (security - after login)
+req.session.regenerate();
+
+// Flash messages (one-time)
+req.session.flash('message', 'Success!');
+const message = req.session.getFlash('message');
+
+// CSRF token
+const token = req.session.getCsrfToken();
+```
+
+## Authentication
+
+Built-in authentication system (request-based):
+
+```javascript
+// Attempt login (inside controller or middleware)
+const success = await req.auth.attempt({
+    email: 'admin@example.com',
+    password: 'secret'
+});
+// veya belirli bir guard ile:
+// const success = await req.auth.guard('user').attempt({ email, password });
+
+// Kullanıcıya erişim
+const user = await req.auth.user();
+// veya
+// const user = await req.auth.guard('user').user();
+
+// Giriş yapmış mı?
+if (req.auth.check()) {
+    // Authenticated
+}
+
+// Çıkış
+await req.auth.logout();
+// veya
+// await req.auth.guard('user').logout();
+```
+
+## Validation
+
+```javascript
+import { Validator } from 'nitronjs';
+
+const validation = Validator.make(req.body, {
+    email: 'required|email',
+    password: 'required|string|min:8',
+    age: 'required|numeric|min:18'
+});
+
+if (validation.fails()) {
+    return res.status(422).send({
+        errors: validation.errors()
+    });
+}
+```
+
+## Environment Variables
+
+Create a `.env` file in your project root:
+
+```env
+APP_NAME=nitronjs
+APP_DEV=true
+APP_DEBUG=true
+APP_PORT=3000
+APP_URL=http://localhost
+
+DATABASE_DRIVER=mysql
+DATABASE_HOST=127.0.0.1
+DATABASE_PORT=3306
+DATABASE_NAME=nitronjs
+DATABASE_USERNAME=root
+DATABASE_PASSWORD=
+```
+
+## Response Methods
+
+```javascript
+// Render view
+return res.view('Site/Home', { title: 'Welcome' });
+
+// JSON response
+return res.json({ success: true, data: users });
+
+// Redirect
+return res.redirect('/dashboard');
+
+// Status code
+return res.status(404).send('Not Found');
+
+// Download file
+return res.download('/path/to/file.pdf');
+```
+
+## Testing Your Application
+
+Build and run in production mode:
+
+```bash
+npm run build
+npm run start
+```
+
+## Requirements
+
+- Node.js 18.x or higher
+- MySQL 5.7+ or MariaDB 10.3+
+
+## License
+
+ISC

package/cli/create.js

@@ -0,0 +1,260 @@
+#!/usr/bin/env node
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import crypto from "crypto";
+import { spawn } from "child_process";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const SKELETON_DIR = path.join(__dirname, "..", "skeleton");
+
+const COLORS = {
+    reset: "\x1b[0m",
+    bold: "\x1b[1m",
+    dim: "\x1b[2m",
+    red: "\x1b[31m",
+    green: "\x1b[32m",
+    yellow: "\x1b[33m",
+    cyan: "\x1b[36m"
+};
+
+function log(message, color = COLORS.reset) {
+    console.log(`${color}${message}${COLORS.reset}`);
+}
+
+function logStep(message, status = "pending") {
+    const icons = {
+        pending: `${COLORS.dim}○${COLORS.reset}`,
+        running: `${COLORS.yellow}◐${COLORS.reset}`,
+        success: `${COLORS.green}✓${COLORS.reset}`,
+        error: `${COLORS.red}✗${COLORS.reset}`
+    };
+    console.log(`  ${icons[status]} ${message}`);
+}
+
+function printBanner() {
+    console.log();
+    log("███╗   ██╗██╗████████╗██████╗  ██████╗ ███╗   ██╗     ██╗███████╗", COLORS.cyan);
+    log("████╗  ██║██║╚══██╔══╝██╔══██╗██╔═══██╗████╗  ██║     ██║██╔════╝", COLORS.cyan);
+    log("██╔██╗ ██║██║   ██║   ██████╔╝██║   ██║██╔██╗ ██║     ██║███████╗", COLORS.cyan);
+    log("██║╚██╗██║██║   ██║   ██╔══██╗██║   ██║██║╚██╗██║██   ██║╚════██║", COLORS.cyan);
+    log("██║ ╚████║██║   ██║   ██║  ██║╚██████╔╝██║ ╚████║╚█████╔╝███████║", COLORS.cyan);
+    log("╚═╝  ╚═══╝╚═╝   ╚═╝   ╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═══╝ ╚════╝ ╚══════╝", COLORS.cyan);
+    console.log();
+}
+
+function printHelp() {
+    console.log(`
+${COLORS.bold}Usage:${COLORS.reset}
+  npx nitronjs <project-name>
+
+${COLORS.bold}Arguments:${COLORS.reset}
+  project-name    Name of the project directory to create
+
+${COLORS.bold}Examples:${COLORS.reset}
+  ${COLORS.cyan}npx nitronjs my-app${COLORS.reset}
+  ${COLORS.cyan}npx nitronjs blog${COLORS.reset}
+  ${COLORS.cyan}npx nitronjs e-commerce${COLORS.reset}
+
+${COLORS.bold}Project name rules:${COLORS.reset}
+  - Can contain letters, numbers, hyphens, and underscores
+  - Cannot start with a number
+  - Cannot contain spaces or special characters
+`);
+}
+
+function validateProjectName(name) {
+    if (!name) {
+        return { valid: false, error: "Project name is required" };
+    }
+
+    if (/^\d/.test(name)) {
+        return { valid: false, error: "Project name cannot start with a number" };
+    }
+
+    if (!/^[a-zA-Z][a-zA-Z0-9_-]*$/.test(name)) {
+        return { valid: false, error: "Project name can only contain letters, numbers, hyphens, and underscores" };
+    }
+
+    if (name.length < 2) {
+        return { valid: false, error: "Project name must be at least 2 characters" };
+    }
+
+    if (name.length > 50) {
+        return { valid: false, error: "Project name cannot exceed 50 characters" };
+    }
+
+    return { valid: true };
+}
+
+function copyDir(src, dest) {
+    if (!fs.existsSync(dest)) {
+        fs.mkdirSync(dest, { recursive: true });
+    }
+
+    const entries = fs.readdirSync(src, { withFileTypes: true });
+    let fileCount = 0;
+
+    for (const entry of entries) {
+        const srcPath = path.join(src, entry.name);
+        const destPath = path.join(dest, entry.name);
+
+        if (entry.isDirectory()) {
+            fileCount += copyDir(srcPath, destPath);
+        } else {
+            fs.copyFileSync(srcPath, destPath);
+            fileCount++;
+        }
+    }
+
+    return fileCount;
+}
+
+function generateAppKey() {
+    return crypto.randomBytes(32).toString("base64");
+}
+
+function updatePackageJson(projectPath, projectName) {
+    const pkgPath = path.join(projectPath, "package.json");
+
+    if (fs.existsSync(pkgPath)) {
+        const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+        pkg.name = projectName;
+        fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 4));
+    }
+}
+
+function updateEnvFile(projectPath) {
+    const envPath = path.join(projectPath, ".env");
+
+    if (fs.existsSync(envPath)) {
+        let content = fs.readFileSync(envPath, "utf-8");
+        const appKey = generateAppKey();
+        content = content.replace(/APP_KEY=.*/, `APP_KEY=${appKey}`);
+        fs.writeFileSync(envPath, content);
+    }
+}
+
+function runNpmInstall(projectPath) {
+    return new Promise((resolve, reject) => {
+        const isWindows = process.platform === "win32";
+        const npm = isWindows ? "npm.cmd" : "npm";
+        
+        const child = spawn(npm, ["install"], {
+            cwd: projectPath,
+            stdio: ["pipe", "pipe", "pipe"]
+        });
+
+        let output = "";
+        
+        child.stdout.on("data", (data) => {
+            output += data.toString();
+        });
+        
+        child.stderr.on("data", (data) => {
+            output += data.toString();
+        });
+
+        child.on("close", (code) => {
+            if (code === 0) {
+                resolve(output);
+            } else {
+                reject(new Error(`npm install failed with code ${code}`));
+            }
+        });
+
+        child.on("error", (err) => {
+            reject(err);
+        });
+    });
+}
+
+function printSuccess(projectName) {
+    console.log();
+    log("╔══════════════════════════════════════════════════════════════╗", COLORS.green);
+    log("║                                                              ║", COLORS.green);
+    log("║   ✓ Project created successfully!                           ║", COLORS.green);
+    log("║                                                              ║", COLORS.green);
+    log("╚══════════════════════════════════════════════════════════════╝", COLORS.green);
+    console.log();
+
+    log(`${COLORS.bold}Next steps:${COLORS.reset}`);
+    console.log();
+    log(`  ${COLORS.dim}1.${COLORS.reset} ${COLORS.cyan}cd ${projectName}${COLORS.reset}`);
+    log(`  ${COLORS.dim}2.${COLORS.reset} Configure your ${COLORS.yellow}.env${COLORS.reset} file`);
+    log(`  ${COLORS.dim}3.${COLORS.reset} ${COLORS.cyan}njs migrate${COLORS.reset}`);
+    log(`  ${COLORS.dim}4.${COLORS.reset} ${COLORS.cyan}njs dev${COLORS.reset}`);
+    console.log();
+
+    log(`${COLORS.bold}Useful commands:${COLORS.reset}`);
+    console.log();
+    log(`  ${COLORS.cyan}njs dev${COLORS.reset}              ${COLORS.dim}Start development server${COLORS.reset}`);
+    log(`  ${COLORS.cyan}njs build${COLORS.reset}            ${COLORS.dim}Build for production${COLORS.reset}`);
+    log(`  ${COLORS.cyan}njs start${COLORS.reset}            ${COLORS.dim}Start production server${COLORS.reset}`);
+    log(`  ${COLORS.cyan}njs migrate${COLORS.reset}          ${COLORS.dim}Run database migrations${COLORS.reset}`);
+    log(`  ${COLORS.cyan}njs seed${COLORS.reset}             ${COLORS.dim}Run database seeders${COLORS.reset}`);
+    log(`  ${COLORS.cyan}njs make:controller${COLORS.reset}  ${COLORS.dim}Create a new controller${COLORS.reset}`);
+    log(`  ${COLORS.cyan}njs make:model${COLORS.reset}       ${COLORS.dim}Create a new model${COLORS.reset}`);
+    console.log();
+
+    log(`${COLORS.dim}Documentation: https://nitronjs.dev/docs${COLORS.reset}`);
+    console.log();
+}
+
+export default async function create(projectName, options = {}) {
+    if (options.help || projectName === "--help" || projectName === "-h") {
+        printHelp();
+        return;
+    }
+
+    printBanner();
+
+    const validation = validateProjectName(projectName);
+    if (!validation.valid) {
+        log(`${COLORS.red}Error: ${validation.error}${COLORS.reset}`);
+        console.log();
+        log(`${COLORS.dim}Run 'npx nitronjs --help' for usage information${COLORS.reset}`);
+        process.exit(1);
+    }
+
+    const projectPath = path.resolve(process.cwd(), projectName);
+
+    if (fs.existsSync(projectPath)) {
+        log(`${COLORS.red}Error: Directory "${projectName}" already exists${COLORS.reset}`);
+        console.log();
+        log(`${COLORS.dim}Please choose a different project name or remove the existing directory${COLORS.reset}`);
+        process.exit(1);
+    }
+
+    if (!fs.existsSync(SKELETON_DIR)) {
+        log(`${COLORS.red}Error: Skeleton directory not found${COLORS.reset}`);
+        log(`${COLORS.dim}This may indicate a corrupted installation. Try reinstalling NitronJS.${COLORS.reset}`);
+        process.exit(1);
+    }
+
+    log(`${COLORS.bold}Creating project: ${COLORS.cyan}${projectName}${COLORS.reset}`);
+    console.log();
+
+    logStep("Copying project files...", "running");
+    const fileCount = copyDir(SKELETON_DIR, projectPath);
+    logStep(`Copied ${fileCount} files`, "success");
+
+    logStep("Configuring package.json...", "running");
+    updatePackageJson(projectPath, projectName);
+    logStep("Package configured", "success");
+
+    logStep("Generating APP_KEY...", "running");
+    updateEnvFile(projectPath);
+    logStep("APP_KEY generated", "success");
+
+    logStep("Installing dependencies (this may take a moment)...", "running");
+    try {
+        await runNpmInstall(projectPath);
+        logStep("Dependencies installed", "success");
+    } catch (error) {
+        logStep("Failed to install dependencies", "error");
+        log(`${COLORS.yellow}Please run 'npm install' manually in the project directory${COLORS.reset}`);
+    }
+
+    printSuccess(projectName);
+}