create-lyrajs 1.0.0

package/LICENSE

@@ -0,0 +1,38 @@
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2025 Matthieu Fergola
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+---
+
+CONTRIBUTOR LICENSE AGREEMENT
+
+By submitting a contribution to this project, you agree that:
+
+1. You grant Matthieu Fergola (the project owner) a perpetual, worldwide,
+   non-exclusive, royalty-free, irrevocable license to use, reproduce,
+   modify, display, perform, sublicense, and distribute your contribution
+   under any license terms (including proprietary licenses).
+
+2. You grant Matthieu Fergola the right to relicense the entire codebase
+   (including your contributions) under different terms in the future.
+
+3. You certify that your contribution is your original work or you have
+   the right to submit it under these terms.
+
+4. You understand that your contributions will be publicly available
+   under GPL-3.0 to end users, but Matthieu Fergola retains the right
+   to use them in proprietary versions.

package/README.md

@@ -0,0 +1,351 @@
+# create-lyrajs
+
+[![npm version](https://img.shields.io/npm/v/create-lyrajs)](https://www.npmjs.com/package/create-lyrajs)
+[![CLA Assistant](https://cla-assistant.io/readme/badge/devway-eu/lyrajs-template)](https://cla-assistant.io/devway-eu/lyrajs-template)
+[![docs](https://img.shields.io/badge/docs-read-green)](https://lyrajs.dev)
+[![Discord](https://img.shields.io/discord/1449345012604342427?label=discord&logo=discord&logoColor=white)](https://discord.gg/cWvUh8pQNU)
+
+The official project template and scaffolding tool for LyraJS, a lightweight TypeScript framework for building robust APIs.
+
+## About
+
+`create-lyrajs` is the quickest way to start a new LyraJS project. It's a CLI tool that scaffolds a fully-configured LyraJS application with best practices, pre-built authentication, and example code to get you started immediately.
+
+## Role in the Framework
+
+This repository serves as the **project starter** for LyraJS. It provides:
+
+- **CLI Tool** - Interactive project creation via `npm create lyrajs`
+- **Project Template** - Pre-configured application structure with working examples
+- **Best Practices** - Demonstrates recommended patterns and conventions
+- **Starting Point** - Complete foundation for building production APIs
+
+When developers run `npm create lyrajs`, this tool copies the template folder to create a new project with everything needed to start building an API.
+
+## What's Included in the Template
+
+### Pre-built Features
+
+1. **Authentication System**
+   - User registration and login
+   - JWT token generation (access + refresh tokens)
+   - Password hashing with bcrypt
+   - Protected routes via configuration
+
+2. **User Management**
+   - User entity with role support
+   - UserRepository with custom queries
+   - UserController with CRUD operations
+   - Complete user routes
+
+3. **Database Setup**
+   - MySQL/MariaDB configuration
+   - Migration system ready to use
+   - Example entity (User)
+   - Fixture system for seed data
+
+4. **Configuration Files**
+   - `database.yaml` - Database connection settings
+   - `security.yaml` - JWT and access control rules
+   - `router.yaml` - API base path configuration
+   - `parameters.yaml` - Application metadata
+   - `mailer.yaml` - Email service settings
+   - `.env` - Environment variables
+
+5. **Project Structure**
+   - TypeScript configuration
+   - ESLint and Prettier setup
+   - Organized folder structure (controller, entity, repository, router, etc.)
+   - Example code demonstrating patterns
+
+6. **Development Tools**
+   - Hot reload with `npm run dev`
+   - Build scripts
+   - Type definitions
+   - Path aliases configured
+
+### Project Structure
+
+```
+my-project/
+├── src/
+│   ├── controller/        # HTTP request handlers
+│   │   ├── AuthController.ts    # Registration, login, logout
+│   │   └── UserController.ts    # User CRUD operations
+│   ├── entity/            # Database models
+│   │   └── User.ts              # User entity with decorators
+│   ├── repository/        # Data access layer
+│   │   └── UserRepository.ts    # User database operations
+│   ├── router/            # Route definitions
+│   │   ├── index.ts             # Main router setup
+│   │   └── routes/
+│   │       ├── authRoutes.ts    # Auth endpoints
+│   │       └── userRoutes.ts    # User endpoints
+│   ├── middleware/        # Custom middleware
+│   │   └── YourMiddleware.ts    # Example middleware
+│   ├── services/          # Business logic services
+│   │   └── YourService.ts       # Example service
+│   ├── fixtures/          # Seed data
+│   │   └── AppFixtures.ts       # Sample user data
+│   ├── tests/             # Test files
+│   │   └── exemple.test.ts      # Example test
+│   ├── types/             # TypeScript types
+│   │   └── ExempleType.ts       # Example types
+│   └── server.ts          # Application entry point
+├── config/                # YAML configuration files
+│   ├── database.yaml
+│   ├── router.yaml
+│   ├── security.yaml
+│   ├── parameters.yaml
+│   └── mailer.yaml
+├── migrations/            # SQL migration files
+├── .env                   # Environment variables
+├── .prettierrc            # Code formatting rules
+├── eslint.config.js       # Linting configuration
+├── package.json           # Dependencies and scripts
+├── tsconfig.json          # TypeScript configuration
+└── README.md              # Project documentation
+```
+
+## Usage
+
+### Create a New Project
+
+```bash
+# Using npm (recommended)
+npm create lyrajs
+
+# Using npx
+npx create-lyrajs
+
+# Using yarn
+yarn create lyrajs
+```
+
+The CLI will prompt you for a project name:
+
+```bash
+Project name: my-api
+✅ Project "my-api" created.
+➡ cd my-api
+➡ npm install
+➡ npm run dev
+```
+
+### Next Steps After Creation
+
+1. **Configure environment variables** in `.env`:
+   ```env
+   DB_HOST=127.0.0.1
+   DB_PORT=3306
+   DB_USER=root
+   DB_PASSWORD=your_password
+   DB_NAME=my_database
+   JWT_SECRET=your_secret_key
+   ```
+
+2. **Create the database**:
+   ```bash
+   npx maestro create:database
+   ```
+
+3. **Run migrations**:
+   ```bash
+   npx maestro migration:migrate
+   ```
+
+4. **Load sample data** (optional):
+   ```bash
+   npx maestro fixtures:load
+   ```
+
+5. **Start developing**:
+   ```bash
+   npm run dev
+   ```
+
+Your API will be available at `http://localhost:3333/api`
+
+### Pre-built Endpoints
+
+The template includes these working endpoints:
+
+**Authentication:**
+- `POST /api/auth/sign-up` - User registration
+- `POST /api/auth/sign-in` - User login
+- `GET /api/auth/user` - Get authenticated user (protected)
+- `GET /api/auth/sign-out` - Logout (protected)
+
+**User Management:**
+- `GET /api/user/all` - List all users
+- `GET /api/user/:id` - Get user by ID
+- `PUT /api/user/` - Create new user
+- `PATCH /api/user/:id` - Update user
+- `DELETE /api/user/:id` - Delete user
+
+## Contributing
+
+We welcome contributions to improve the template! Here's how you can help:
+
+### Getting Started
+
+1. **Fork the repository**
+   ```bash
+   git clone https://github.com/your-username/lyrajs-template.git
+   cd lyrajs-template
+   ```
+
+2. **Test the CLI locally**
+   ```bash
+   npm link
+
+   # Create a test project
+   cd /path/to/test-location
+   create-lyrajs
+   ```
+
+3. **Make changes to the template**
+   - Edit files in the `template/` folder
+   - Update CLI logic in `src/createApp.js`
+   - Test thoroughly before submitting
+
+### Contribution Guidelines
+
+- **Read the guidelines** - See [CONTRIBUTING.md](https://github.com/devway-eu/lyrajs/blob/main/lyrajs-core/CONTRIBUTING.md)
+- **Maintain consistency** - Follow existing patterns and conventions
+- **Test thoroughly** - Ensure the generated project works correctly
+- **Document changes** - Update the template README if needed
+- **Keep it simple** - The template should be easy to understand for beginners
+
+### Areas for Contribution
+
+We particularly welcome contributions in these areas:
+
+1. **Template Improvements**
+   - Additional example code
+   - Better default configuration
+   - Improved project structure
+   - More comprehensive README in generated projects
+
+2. **Pre-built Features**
+   - Additional authentication methods
+   - Example middleware implementations
+   - Sample services and business logic
+   - Test examples
+
+3. **Developer Experience**
+   - Better error messages
+   - Improved CLI prompts
+   - Setup wizard enhancements
+   - Documentation improvements
+
+4. **Configuration**
+   - Environment-specific configs
+   - Docker setup
+   - CI/CD examples
+   - Deployment guides
+
+5. **Code Quality**
+   - ESLint rule improvements
+   - Prettier configuration
+   - TypeScript strictness
+   - Code comments and documentation
+
+### Pull Request Process
+
+1. **Create a feature branch**
+   ```bash
+   git checkout -b feature/improve-template
+   ```
+
+2. **Make your changes**
+   - Modify files in `template/` folder
+   - Update CLI if needed
+   - Test the generated project
+
+3. **Test the changes**
+   ```bash
+   npm link
+   cd /tmp
+   create-lyrajs
+   cd my-test-project
+   npm install
+   npm run dev
+   ```
+
+4. **Commit and push**
+   ```bash
+   git add .
+   git commit -m "Improve template with [description]"
+   git push origin feature/improve-template
+   ```
+
+5. **Open a Pull Request**
+   - Describe what you changed and why
+   - Include screenshots if UI-related
+   - Ensure the template generates a working project
+
+### Testing Checklist
+
+Before submitting a PR, verify:
+
+- ✅ Generated project installs without errors
+- ✅ `npm run dev` starts successfully
+- ✅ Authentication endpoints work
+- ✅ Database migrations execute properly
+- ✅ TypeScript compiles without errors
+- ✅ ESLint passes
+- ✅ All configuration files are valid
+- ✅ README is clear and accurate
+
+### Reporting Issues
+
+Found a problem with the template?
+
+- **Check existing issues** - Search for similar problems first
+- **Create a new issue** - Use the [issue tracker](https://github.com/devway-eu/lyrajs-template/issues)
+- **Provide details** - Include:
+  - Node.js and npm versions
+  - Operating system
+  - Steps to reproduce
+  - Expected vs actual behavior
+  - Error messages or logs
+
+## Template Customization
+
+When creating your own LyraJS project, you can customize the template by:
+
+1. **Modifying entities** - Add your own entities and relationships
+2. **Adjusting routes** - Change API endpoints and structure
+3. **Customizing authentication** - Adapt to your security requirements
+4. **Adding features** - Extend with your own controllers and services
+5. **Updating configuration** - Adjust settings for your environment
+
+## Links
+
+- **GitHub Repository**: [github.com/devway-eu/lyrajs-template](https://github.com/devway-eu/lyrajs-template)
+- **npm Package**: [npmjs.com/package/create-lyrajs](https://www.npmjs.com/package/create-lyrajs)
+- **Main Repository**: [github.com/devway-eu/lyrajs](https://github.com/devway-eu/lyrajs)
+- **Core Package**: [github.com/devway-eu/lyrajs-core](https://github.com/devway-eu/lyrajs-core)
+- **Documentation**: [lyrajs.dev](https://lyrajs.dev)
+
+## License
+
+LyraJS is licensed under the [GPL-3.0 License](./LICENSE).
+
+## Authors
+
+- **Matthieu Fergola** - Core Developer
+- **Anthony Dewitte** - Core Developer
+
+## Acknowledgments
+
+Built with dedication by the Devway team and our amazing contributors.
+
+---
+
+**Need help?** Check the [documentation](https://lyrajs.dev) or join our [Discussions](https://github.com/devway-eu/lyrajs/discussions).
+
+## Contributors ❤️
+
+![Contributors](https://img.shields.io/github/contributors/devway-eu/lyrajs)

package/cli.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+import { createApp } from './src/createApp.js'
+await createApp()

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "create-lyrajs",
+  "version": "1.0.0",
+  "description": "CLI tool to create new LyraJS projects",
+  "keywords": ["create", "lyrajs", "framework", "NodeJS", "api", "typescript", "cli", "scaffold"],
+  "author": "Matthieu Fergola & Anthony Dewitte",
+  "license": "GPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/devway-eu/lyrajs-template"
+  },
+  "bin": {
+    "create-lyrajs": "cli.js"
+  },
+  "type": "module",
+  "files": [
+    "cli.js",
+    "src",
+    "template",
+    "template/.gitignore"
+  ]
+}

package/src/createApp.js

@@ -0,0 +1,107 @@
+import fs from "fs"
+import path from "path"
+import { fileURLToPath } from "url"
+import { mkdir, cp } from "fs/promises"
+import readline from "readline"
+import { spawn } from "child_process"
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+export async function createApp() {
+    const projectName = await prompt("Project name: ")
+
+    const targetDir = path.resolve(process.cwd(), projectName)
+    const templateDir = path.resolve(__dirname, "../template")
+
+    if (fs.existsSync(targetDir)) {
+        console.error(`❌ Directory ${projectName} already exists.`)
+        process.exit(1)
+    }
+
+    console.log(`\nCreating project "${projectName}"...`)
+
+    await mkdir(targetDir)
+    await cp(templateDir, targetDir, { recursive: true })
+
+    const envExample = path.join(targetDir, '.env.example')
+    if (fs.existsSync(envExample)) {
+        await cp(envExample, path.join(targetDir, '.env'))
+    }
+
+    console.log(`\n✔ Project "${projectName}" created.`)
+
+    const shouldInstall = await confirm("\nInstall dependencies now? (Y/n) ")
+
+    if(shouldInstall)
+    {
+        console.log(`\n➟ Installing dependencies...`)
+
+        const installSuccess = await installDependencies(targetDir)
+
+        if(installSuccess)
+        {
+            console.log(`\n✔ Dependencies installed successfully!\n`)
+            console.log(`You're all set! Run these commands to start:\n`)
+            console.log(`➡ cd ${projectName}`)
+            console.log(`➡ npm run dev`)
+        }
+        else
+        {
+            console.log(`➡ cd ${projectName}`)
+            console.log(`➡ npm install`)
+            console.log(`➡ npm run dev`)
+        }
+    }
+    else
+    {
+        console.log(`➡ cd ${projectName}`)
+        console.log(`➡ npm install`)
+        console.log(`➡ npm run dev`)
+    }
+}
+
+// Simple readline prompt
+function prompt(question) {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+    })
+    return new Promise((resolve) => rl.question(question, (ans) => {
+        rl.close()
+        resolve(ans.trim())
+    }))
+}
+
+function installDependencies(targetDir) {
+    return new Promise((resolve) => {
+        const npmCommand = process.platform === "win32" ? "npm.cmd" : "npm"
+        const install = spawn(npmCommand, ["install"], {
+            cwd: targetDir,
+            stdio: "inherit",
+            shell: true
+        })
+
+        install.on("close", (code) => {
+            resolve(code === 0)
+        })
+
+        install.on("error", () => {
+            resolve(false)
+        })
+    })
+}
+
+function confirm(question) {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout
+    })
+    return new Promise((resolve) => {
+    rl.question(question, (ans) => {
+            rl.close()
+            const answer = ans.trim().toLowerCase()
+            // Default to yes if empty or starts with 'y'
+            resolve(answer === "" || answer === "y" || answer === "yes")
+        })
+    })
+}

package/template/.env.example

@@ -0,0 +1,30 @@
+# Node environment
+NODE_ENV=dev
+# Time zone
+TZ=Europe/Paris
+# Limits
+REQUEST_MAX_SIZE=10mb
+# API host
+HOST=localhost
+# API port
+PORT=3333
+# Database
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USER=root
+DB_PASSWORD=
+DB_NAME=your_database_name
+# Session driver
+SESSION_DRIVER=cookie
+# Client app url
+CLIENT_APP_URL=http://localhost:5173
+# JWT
+JWT_SECRET=your_very_long_random_secret_key_here
+JWT_SECRET_REFRESH=your_different_very_long_refresh_secret_here
+JWT_ALGORITHM=HS256
+# Mailer
+MAILER_HOST=mailer_dns
+MAILER_PORT=465
+MAILER_USER=mailer_user
+MAILER_PASS=mailer_password
+MAILER_SENDER=donotrespond@mail.com

package/template/.gitignore

@@ -0,0 +1,51 @@
+# Dependencies
+node_modules/
+package-lock.json
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Build output
+dist/
+build/
+*.tsbuildinfo
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Runtime data
+pids/
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory
+coverage/
+.nyc_output/
+
+# IDE and editors
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+Thumbs.db
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Temporary files
+tmp/
+temp/
+*.tmp

package/template/.prettierignore

@@ -0,0 +1,2 @@
+build
+node_modules

package/template/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "semi": false,
+  "tabWidth": 2,
+  "singleQuote": false,
+  "trailingComma": "none",
+  "printWidth": 120,
+  "endOfLine": "lf"
+}

package/template/README.md

@@ -0,0 +1,39 @@
+# LyraJS
+
+A simple framework for building web API with Node.js.
+
+We wanted to create a framework as similar as possible to the Symfony framework, with a CLI to help you create your API faster.
+
+By default, the framework provides :
+- Routing
+- Middlewares
+- User and role entities, repositories, controllers and routes
+- Authentication with JWT
+- CORS
+- ORM for MySQL database managment
+- Error handling
+- CLI to help you create your API faster
+
+Our CLI includes :
+- A command to create a new entity and repository
+- A command to create a new controller
+- A command to create a new migration
+- A command to apply last migration to make database tables corresponding to entities
+- A command to load fixtures data in database
+- A command "help" to display all available commands
+
+## Installation
+
+```bash
+    git clone https://github.com/devway-eu/LyraJS.git
+```
+
+```bash
+    npm install
+```
+
+## Run services
+
+```bash
+    npm run dev
+```

package/template/config/database.yaml

@@ -0,0 +1,6 @@
+database:
+  host: "%env(DB_HOST)%"
+  port: "%env(DB_PORT)%"
+  user: "%env(DB_USER)%"
+  password: "%env(DB_PASSWORD)%"
+  name: "%env(DB_NAME)%"

package/template/config/mailer.yaml

@@ -0,0 +1,6 @@
+mailer:
+  host: "%env(MAILER_HOST)%"
+  port: "%env(MAILER_PORT)%"
+  username: "%env(MAILER_USERNAME)%"
+  password: "%env(MAILER_PASSWORD)%"
+  sender: "%env(MAILER_SENDER)%"

package/template/config/parameters.yaml

@@ -0,0 +1,7 @@
+parameters:
+  api_name: "LyraJS API"
+  api_version: "1.0.0"
+  api_host: "%env(HOST)%"
+  api_port: "%env(PORT)%"
+  api_env: "%env(NODE_ENV)%"
+  api_timezone: "%env(TZ)%"

package/template/config/router.yaml

@@ -0,0 +1,2 @@
+router:
+  base_path: /api

package/template/config/security.yaml

@@ -0,0 +1,22 @@
+security:
+  jwt:
+    secret_key: "%env(JWT_SECRET)%"
+    token_expiration: 3600
+    secret_key_refresh: "%env(JWT_SECRET_REFRESH)%"
+    refresh_token_expiration: 86400
+    algorithm: "%env(JWT_ALGORITHM)%"
+  auth_routes:
+    sign_out: "/api/v1/sign-out"
+  limits:
+    request_max_size: "%env(REQUEST_MAX_SIZE)%"
+  rate_limiter:
+    time: 900000 # 15 minutes (ms)
+    max_attempts: 5
+    message: 'Too many login attempts, please try again later'
+  access_control:
+    - { path: /api/v1/auth/sign-out, roles: [ROLE_USER] }
+    - { path: /api/v1/auth/user, roles: [ROLE_USER] }
+    - { path: /api/v1/admin, roles: [ROLE_ADMIN] }
+  role_hierarchy:
+    ROLE_ADMIN: ROLE_USER
+    ROLE_SUPER_ADMIN: ROLE_ADMIN

package/template/eslint.config.js

@@ -0,0 +1,53 @@
+import js from "@eslint/js"
+import globals from "globals"
+import tseslint from "typescript-eslint"
+import eslintConfigPrettier from "eslint-config-prettier"
+import eslintPluginPrettier from "eslint-plugin-prettier"
+import eslintPluginSimpleImportSort from "eslint-plugin-simple-import-sort"
+
+export default tseslint.config(
+  { ignores: ["dist"] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended, eslintConfigPrettier],
+    files: ["**/*.{ts,tsx}"],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.node
+    },
+    plugins: {
+      prettier: eslintPluginPrettier,
+      "simple-import-sort": eslintPluginSimpleImportSort
+    },
+    rules: {
+      "no-useless-catch": "off",
+      "prettier/prettier": "warn",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          argsIgnorePattern: "^_",
+          varsIgnorePattern: "^_",
+          caughtErrorsIgnorePattern: "^_"
+        }
+      ],
+      "@typescript-eslint/no-throw-literal": "off",
+      "no-throw-literal": "off",
+      "@typescript-eslint/only-throw-error": "off",
+      "@typescript-eslint/prefer-promise-reject-errors": "off",
+      "simple-import-sort/imports": [
+        "error",
+        {
+          groups: [
+            ["^\\u0000"],
+            ["^@?\\w"],
+            [
+              "^(@app|@config|@core|@controllers|@fixtures|@middlewares|@entity|@repository|@router|@services|@tests|@types)(/.*|$)"
+            ],
+            ["^\\.\\.(?!/?$)", "^\\.\\./?$"],
+            ["^\\./(?=.*/)(?!/?$)", "^\\.(?!/?$)", "^\\./?$"],
+            ["^.+\\.s?css$"]
+          ]
+        }
+      ]
+    }
+  }
+)

package/template/migrations/migration_1752052338457.sql

@@ -0,0 +1,3 @@
+USE `nodejs_sql`;
+DROP TABLE IF EXISTS `user`;
+CREATE TABLE IF NOT EXISTS `user` (`id` BIGINT AUTO_INCREMENT NOT NULL, `username` VARCHAR (255)  NOT NULL , `firstname` VARCHAR (255)  NOT NULL , `lastname` VARCHAR (255)  NOT NULL , `email` VARCHAR (255)  NOT NULL UNIQUE, `password` VARCHAR (255)  NOT NULL , `role` VARCHAR (255)  NOT NULL , `refresh_token` VARCHAR (255)   , `created_at` TIMESTAMP  NOT NULL , `updated_at` TIMESTAMP  NOT NULL , PRIMARY KEY (`id`));

package/template/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "LyraJS API",
+  "type": "module",
+  "scripts": {
+    "dev": "tsx watch src/server.ts",
+    "start": "tsx src/server.ts",
+    "maestro": "maestro"
+  },
+  "dependencies": {
+    "bcrypt": "^6.0.0",
+    "cookie-parser": "^1.4.7",
+    "cors": "^2.8.5",
+    "dotenv": "^16.5.0",
+    "express": "^5.1.0",
+    "express-rate-limit": "^8.2.1",
+    "jsonwebtoken": "^9.0.2",
+    "mysql2": "^3.14.1",
+    "nodemailer": "^7.0.7",
+    "reflect-metadata": "^0.2.2",
+    "yaml": "^2.8.0"
+  },
+  "devDependencies": {
+    "@lyrajs/core": "^1.0.0",
+    "@types/bcrypt": "^5.0.2",
+    "@types/cookie-parser": "^1.4.8",
+    "@types/cors": "^2.8.18",
+    "@types/dotenv": "^8.2.3",
+    "@types/express": "^5.0.1",
+    "@types/jsonwebtoken": "^9.0.9",
+    "@types/node": "^22.15.17",
+    "@types/nodemailer": "^6.4.17",
+    "@typescript-eslint/eslint-plugin": "^8.23.0",
+    "@typescript-eslint/parser": "^8.23.0",
+    "eslint": "^9.20.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "inquirer": "^12.7.0",
+    "tsx": "^4.19.4",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.23.0"
+  }
+}

package/template/src/controller/AuthController.ts

@@ -0,0 +1,124 @@
+import bcrypt from "bcrypt"
+import { NextFunction, Request, Response } from "express"
+import jwt from "jsonwebtoken"
+
+import { SecurityConfig } from "@lyrajs/core"
+import { AuthenticatedRequest, UnauthorizedException, Validator } from "@lyrajs/core"
+import { User } from "@entity/User"
+import { userRepository } from "@repository/UserRepository"
+
+const securityConfig = new SecurityConfig().getConfig()
+
+export class AuthController {
+  static signUp = async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { username, firstname, lastname, email, password } = req.body
+
+      if (!username || !firstname || !lastname || !email || !password) {
+        throw new Error("Missing required fields")
+      }
+
+      if (!Validator.isUsernameValid(username)) {
+        throw new Error("Invalid username")
+      }
+
+      if (!Validator.isEmailValid(email)) {
+        throw new Error("Invalid email")
+      }
+
+      const isEmailUsed = await userRepository.findOneBy({ email })
+
+      if (isEmailUsed) {
+        throw new Error("Email already in use")
+      }
+
+      if (!Validator.isPasswordValid(password)) {
+        throw new Error("Invalid password")
+      }
+
+      const user = new User()
+      const hashedPassword = await bcrypt.hash(password, 10)
+
+      user.username = username
+      user.firstname = firstname
+      user.lastname = lastname
+      user.email = email
+      user.password = hashedPassword
+      user.role = 'ROLE_USER'
+
+      await userRepository.save(user)
+
+      const registeredUser = await userRepository.findOneBy({ email })
+
+      delete registeredUser?.password
+
+      res.status(201).json({ message: "User registered successfully", user: registeredUser })
+    } catch (error) {
+      next(error)
+    }
+  }
+
+  static signIn = async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { email, password } = req.body
+
+      if (!email || !password) {
+        throw new Error("Missing required fields")
+      }
+
+      const user = await userRepository.findOneBy({ email })
+
+      if (!user || !(user && (await bcrypt.compare(password, user.password)))) {
+        throw new Error("Invalid credentials")
+      }
+
+      const token = jwt.sign({ id: user.id }, securityConfig.jwt.secret_key as string, {
+        algorithm: securityConfig.jwt.algorithm as string,
+        expiresIn: securityConfig.jwt.token_expiration
+      })
+
+      user.refresh_token = jwt.sign({ id: user.id }, securityConfig.jwt.secret_key_refresh as string, {
+        algorithm: securityConfig.jwt.algorithm as string,
+        expiresIn: securityConfig.jwt.refresh_token_expiration
+      })
+
+      await userRepository.save(user)
+
+      res.cookie("Token", token, {
+        sameSite: "Lax",
+        httpOnly: true,
+        secure: process.env.ENV === "production",
+        maxAge: 1000 * 60 * 60 * 24,
+        partitioned: false
+      })
+
+      delete user.password
+
+      res.status(200).json({ message: "User authenticated in successfully", user, token })
+    } catch (error) {
+      next(error)
+    }
+  }
+
+  static getAuthenticatedUser = async (req: AuthenticatedRequest<Request>, res: Response, next: NextFunction) => {
+    try {
+      const user = req.user as User
+
+      if (!user) throw new UnauthorizedException()
+
+      res.status(200).json({
+        firstname: user.firstname,
+        lastname: user.lastname,
+        email: user.email,
+        role: user.role
+      })
+    } catch (error) {
+      next(error)
+    }
+  }
+
+  static signOut = async (_req: Request, res: Response) => {
+    res.clearCookie("Token")
+    res.status(200).json({ message: "Unauthenticated successfully" })
+  }
+}

package/template/src/controller/UserController.ts

@@ -0,0 +1,91 @@
+import { NextFunction, Request, Response } from "express"
+import { Validator, ValidationException } from "@lyrajs/core"
+import { User } from "@entity/User"
+import { userRepository } from "@repository/UserRepository"
+
+export class UserController {
+  static list = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
+    try {
+      const users = await userRepository.findAll().map( (user: User) => {
+          delete user.password
+          return user
+      } )
+      res.status(200).json({ message: "Users fetched successfully", users })
+    } catch (error) {
+      next(error)
+    }
+  }
+
+  static read = async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { id } = req.params
+      const user = await userRepository.find(id)
+      delete user?.password
+      res.status(200).json({ message: "User fetched successfully", user })
+    } catch (error) {
+      next(error)
+    }
+  }
+
+  static create = async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { data }: {data: User} = req.body
+
+      if(
+        !data.email || !data.password ||
+        !data.firstname || !data.lastname ||
+        !data.username
+      )
+      {
+        new ValidationException("All fields are required.")
+      }
+
+      if( !Validator.isUsernameValid(data.username) )
+      {
+        new ValidationException("Username to short (min 2 characters, only alphabetical characters and underscores )")
+      }
+
+      if( !Validator.isEmailValid(data.email) )
+      {
+        new ValidationException("Invalid email format.")
+      }
+
+      if( !Validator.isPasswordValid(data.password) )
+      {
+        new ValidationException("Password is to weak. I must be 10 characters long, including at least 1 lowercase, 1 uppercase, 1 number and 1 special character.")
+      }
+
+      data.role = "ROLE_USER";
+
+      await userRepository.save(data)
+      res.status(201).json({ message: "User created successfully" })
+    } catch (error) {
+      next(error)
+    }
+  }
+
+  static update = async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { data }: {data: User} = req.body
+      const user = await userRepository.find(data.id)
+      if (!user) res.status(404).json({ message: "User not found" })
+      if (user) await userRepository.save(data)
+      res.status(200).json({ message: "Users updated successfully" })
+    } catch (error) {
+      next(error)
+    }
+  }
+
+  static delete = async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      const { id } = req.params
+      const user = await userRepository.find(id)
+      if (!user) res.status(404).json({ message: "User not found" })
+      if (!user?.id) res.status(400).json({ message: "Invalid user id" })
+      if (user?.id && id) await userRepository.delete(id)
+      res.status(200).json({ message: "User deleted successfully" })
+    } catch (error) {
+      next(error)
+    }
+  }
+}

package/template/src/entity/User.ts

@@ -0,0 +1,29 @@
+import { Column, Entity, Table } from "@lyrajs/core"
+
+@Table()
+export class User extends Entity<User> {
+  @Column({ type: "bigint", pk: true })
+  id: number
+  @Column({ type: "varchar", size: 255 })
+  username: string = ""
+  @Column({ type: "varchar", size: 255 })
+  firstname: string = ""
+  @Column({ type: "varchar", size: 255 })
+  lastname: string = ""
+  @Column({ type: "varchar", size: 255, unique: true })
+  email: string = ""
+  @Column({ type: "varchar", size: 255 })
+  password: string = ""
+  @Column({ type: "varchar", size: 255 })
+  role: string = "ROLE_USER"
+  @Column({ type: "varchar", size: 255, nullable: true })
+  refresh_token: string | null = null
+  @Column({ type: "timestamp" })
+  created_at: string | Date | null = new Date()
+  @Column({ type: "timestamp" })
+  updated_at: string | Date | null = new Date()
+
+  constructor(user?: Partial<User> | User) {
+    super(user)
+  }
+}

package/template/src/fixtures/AppFixtures.ts

@@ -0,0 +1,49 @@
+import bcrypt from "bcrypt"
+
+import { User } from "@entity/User"
+import { userRepository } from "@repository/UserRepository"
+
+export class AppFixtures {
+  private users = [
+    {
+      username: "Mithrandil",
+      firstname: "Gandalf",
+      lastname: "Thewhite",
+      email: "gandalf@mail.com",
+      password: "Y0u$ha11n0tpa$$!"
+    },
+    {
+      username: "Pippin",
+      firstname: "Peregrin",
+      lastname: "Took",
+      email: "pippin@mail.com",
+      password: "Mu$hr0000m$!!"
+    },
+    {
+      username: "Merry",
+      firstname: "Meriadoc",
+      lastname: "Brandybuck",
+      email: "merry@mail.com",
+      password: "Mu$hr0000m$!!"
+    }
+  ]
+
+  load = async () => {
+    await this.loadUsers()
+  }
+
+  private loadUsers = async () => {
+    for (const u of this.users) {
+      const hashedPassword = await bcrypt.hash(u.password, 10)
+      const user = new User()
+      user.username = u.username
+      user.firstname = u.firstname
+      user.lastname = u.lastname
+      user.email = u.email
+      user.password = hashedPassword
+      user.created_at = new Date()
+      user.updated_at = new Date()
+      await userRepository.save(user)
+    }
+  }
+}

package/template/src/middleware/YourMiddleware.ts

@@ -0,0 +1,6 @@
+import { NextFunction, Request, Response } from "express"
+
+export const YourMiddleware = (req: Request, res: Response, next: NextFunction) => {
+  console.log("Your middleware checks or does something here...")
+  next()
+}

package/template/src/repository/UserRepository.ts

@@ -0,0 +1,10 @@
+import { Repository } from "@lyrajs/core"
+import { User } from "@entity/User"
+
+class UserRepository extends Repository<User> {
+  constructor() {
+    super(User)
+  }
+}
+
+export const userRepository = new UserRepository()

package/template/src/router/index.ts

@@ -0,0 +1,14 @@
+import { Response, Router } from "express"
+
+import { Config } from "@lyrajs/core"
+import { routes } from "@router/routes"
+
+const routerBasePath = new Config().get("router.base_path")
+
+export const router = Router()
+
+router.use(routerBasePath, routes)
+
+router.get("/", (req, res: Response) => {
+  res.send("Nothing here...")
+})

package/template/src/router/routes/authRoutes.ts

@@ -0,0 +1,10 @@
+import { AuthController } from "@controller/AuthController"
+import { Router } from "express"
+import { rateLimiter } from "@lyrajs/core"
+
+export const authRoutes = Router()
+
+authRoutes.post("/sign-up", AuthController.signUp)
+authRoutes.post("/sign-in", rateLimiter, AuthController.signIn)
+authRoutes.get("/user", AuthController.getAuthenticatedUser)
+authRoutes.get("/sign-out", AuthController.signOut)

package/template/src/router/routes/index.ts

@@ -0,0 +1,9 @@
+import { Router } from "express"
+
+import { authRoutes } from "./authRoutes"
+import { userRoutes } from "./userRoutes"
+
+export const routes = Router()
+
+routes.use("/auth", authRoutes)
+routes.use("/user", userRoutes)

package/template/src/router/routes/userRoutes.ts

@@ -0,0 +1,10 @@
+import { UserController } from "@controller/UserController"
+import { Router } from "express"
+
+export const userRoutes = Router()
+
+userRoutes.get("/all", UserController.list)
+userRoutes.get("/:id", UserController.read)
+userRoutes.put("/", UserController.create)
+userRoutes.patch("/:id", UserController.update)
+userRoutes.delete("/:id", UserController.delete)

package/template/src/server.ts

@@ -0,0 +1,44 @@
+import cookieParser from "cookie-parser"
+import cors from "cors"
+import * as dotenv from "dotenv"
+import express from "express"
+import * as process from "node:process"
+
+import { router } from "@app/router"
+import { Config, LyraConsole, accessMiddleware, errorHandler, httpRequestMiddleware } from "@lyrajs/core"
+
+dotenv.config()
+
+const params = new Config().get("parameters")
+const securityConfig = new Config().get("security")
+
+const port = process.env.PORT
+const app = express()
+
+app.set("trust proxy", true)
+app.use(cookieParser())
+app.use(express.json({ limit: securityConfig.limits.request_max_size || "10mb" }))
+app.use(express.urlencoded({ limit: securityConfig.limits.request_max_size || "10mb", extended: true }))
+app.use(
+  cors({
+    origin: `${process.env.CLIENT_APP_URL}`,
+    methods: ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"],
+    credentials: true
+  })
+)
+app.use(httpRequestMiddleware)
+app.use(accessMiddleware)
+app.use(router)
+app.use(errorHandler)
+
+app.listen(port, (err?: Error) => {
+  if (err) {
+    LyraConsole.error("Error starting server:", err.message)
+  } else {
+    LyraConsole.info(
+      `${params.api_name} v${params.api_version}`,
+      `Server running at ${params.api_host}:${params.api_port}`,
+      ""
+    )
+  }
+})

package/template/src/services/YourService.ts

@@ -0,0 +1,5 @@
+export class YourService {
+  exemple() {
+    console.log("Here is a method of your service...")
+  }
+}

package/template/src/tests/exemple.test.ts

@@ -0,0 +1,11 @@
+/*
+
+function exemple(arg) {
+  return arg
+}
+
+// i.e. using Jest :
+
+expect(exemple("your value")).toBe("your value")
+
+*/

package/template/src/types/ExempleType.ts

@@ -0,0 +1,4 @@
+export interface ExempleType {
+  id: number
+  name: string
+}

package/template/tsconfig.json

@@ -0,0 +1,62 @@
+{
+  "compilerOptions": {
+    "module": "esnext",
+    "baseUrl": ".",
+    "target": "es2017",
+    "lib": [
+      "esnext"
+    ],
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "resolveJsonModule": true,
+    "skipDefaultLibCheck": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "outDir": "./dist",
+    "strictPropertyInitialization": false,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "paths": {
+      "@app/*": [
+        "./src/*"
+      ],
+      "@config/*": [
+        "./config/*"
+      ],
+      "@controller/*": [
+        "./src/controller/*"
+      ],
+      "@fixtures/*": [
+        "./src/fixtures/*"
+      ],
+      "@middleware/*": [
+        "./src/middleware/*"
+      ],
+      "@entity/*": [
+        "./src/entity/*"
+      ],
+      "@repository/*": [
+        "./src/repository/*"
+      ],
+      "@router/*": [
+        "./src/router/*"
+      ],
+      "@services/*": [
+        "./src/services/*"
+      ],
+      "@tests/*": [
+        "./src/tests/*"
+      ],
+      "@types/*": [
+        "./src/types/*"
+      ]
+    }
+  },
+  "ts-node": {
+    "require": [
+      "tsconfig-paths/register"
+    ]
+  }
+}