create-lyrajs 2.0.0 → 2.0.1

package/README.md

@@ -31,20 +31,44 @@ When developers run `npm create lyrajs`, this tool copies the template folder to
    - JWT token generation (access + refresh tokens)
    - Password hashing with bcrypt
    - Protected routes via configuration
+   - Enhanced with dependency injection 🆕
 
 2. **User Management**
    - User entity with role support
    - UserRepository with custom queries
-   - UserController with CRUD operations
-   - Complete user routes
+   - UserController with CRUD operations and decorator support 🆕
+   - Flexible routing (traditional routes or decorators) 🆕
 
 3. **Database Setup**
    - MySQL/MariaDB configuration
-   - Migration system ready to use
+   - Migration system with backup/restore 🆕
    - Example entity (User)
-   - Fixture system for seed data
-
-4. **Configuration Files**
+   - Enhanced fixture system with dependencies 🆕
+
+4. **Server-Side Rendering (SSR)** 🆕
+   - JSX/TSX template engine configured
+   - Example template files
+   - Layout system for consistent page structure
+   - Ready to use for HTML responses
+
+5. **Job Scheduling** 🆕
+   - Pre-configured scheduler system
+   - Example job with cron schedule
+   - Timezone support
+   - Jobs auto-discovered from `src/jobs/`
+
+6. **Static Assets** 🆕
+   - Public directory for static files
+   - Configured static file serving
+   - Ready for images, CSS, fonts, etc.
+
+7. **Dependency Injection** 🆕
+   - DI container configured
+   - Third-party libraries registered (bcrypt, jwt)
+   - Auto-injection in controllers and services
+   - Singleton service management
+
+8. **Configuration Files**
    - `database.yaml` - Database connection settings
    - `security.yaml` - JWT and access control rules
    - `router.yaml` - API base path configuration
@@ -52,46 +76,55 @@ When developers run `npm create lyrajs`, this tool copies the template folder to
    - `mailer.yaml` - Email service settings
    - `.env` - Environment variables
 
-5. **Project Structure**
+9. **Project Structure**
    - TypeScript configuration
    - ESLint and Prettier setup
-   - Organized folder structure (controller, entity, repository, router, etc.)
-   - Example code demonstrating patterns
+   - Organized folder structure with new v2 directories
+   - Example code demonstrating both traditional and modern patterns
 
-6. **Development Tools**
+10. **Development Tools**
    - Hot reload with `npm run dev`
    - Build scripts
    - Type definitions
    - Path aliases configured
+   - Enhanced CLI with new commands 🆕
 
 ### Project Structure
 
 ```
 my-project/
 ├── src/
-│   ├── controller/        # HTTP request handlers
+│   ├── controller/        # HTTP controllers (decorator or traditional)
 │   │   ├── 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
+│   ├── router/            # Route definitions (traditional routing)
 │   │   ├── 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
+│   ├── middleware/        # Custom middleware
+│   │   └── YourMiddleware.ts    # Example middleware
+│   ├── jobs/              # 🆕 Scheduled jobs
+│   │   └── ExampleJob.ts        # Example cron job
+│   ├── templates/         # 🆕 SSR templates (JSX/TSX)
+│   │   ├── ExampleRender.tsx    # Example template
+│   │   ├── layout/              # Layout templates
+│   │   └── README.md            # Template documentation
 │   ├── 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
+│   └── server.ts          # Application entry point (updated for v2)
+├── public/                # 🆕 Static assets
+│   └── assets/            # Images, CSS, fonts, etc.
 ├── config/                # YAML configuration files
 │   ├── database.yaml
 │   ├── router.yaml
@@ -99,6 +132,8 @@ my-project/
 │   ├── parameters.yaml
 │   └── mailer.yaml
 ├── migrations/            # SQL migration files
+├── backups/               # 🆕 Database backups
+├── logs/                  # 🆕 Application logs
 ├── .env                   # Environment variables
 ├── .prettierrc            # Code formatting rules
 ├── eslint.config.js       # Linting configuration
@@ -107,6 +142,8 @@ my-project/
 └── README.md              # Project documentation
 ```
 
+> **Note:** LyraJS v2 supports both traditional routing (`src/router/`) and decorator-based routing. Choose the approach that works best for your project.
+
 ## Usage
 
 ### Create a New Project
@@ -183,6 +220,8 @@ The template includes these working endpoints:
 - `PATCH /api/user/:id` - Update user
 - `DELETE /api/user/:id` - Delete user
 
+> **Note:** In v2, you can define these routes either with traditional route files or using decorators directly in controllers (`@Get`, `@Post`, etc.).
+
 ## Contributing
 
 We welcome contributions to improve the template! Here's how you can help:
@@ -335,8 +374,7 @@ LyraJS is licensed under the [GPL-3.0 License](./LICENSE).
 
 ## Authors
 
-- **Matthieu Fergola** - Core Developer
-- **Anthony Dewitte** - Core Developer
+- Matthieu Fergola
 
 ## Acknowledgments
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-lyrajs",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "CLI tool to create new LyraJS projects",
   "keywords": [
     "create",

package/template/package.json

@@ -7,7 +7,7 @@
     "maestro": "maestro"
   },
   "dependencies": {
-    "@lyra-js/core": "^2.0.0",
+    "@lyra-js/core": "^2.0.1",
     "bcrypt": "^6.0.0",
     "cors": "^2.8.5",
     "dotenv": "^16.5.0",

package/template/public/assets/styles/app.css

@@ -0,0 +1,158 @@
+* {
+    box-sizing: border-box;
+}
+
+html, body {
+    margin: 0;
+    padding: 0;
+}
+
+html {
+    font-size: 62.5%;
+}
+
+body {
+    background-color: #1f202a;
+    color: #dedff6;
+    font-size: 1.8rem;
+    font-family: sans-serif;
+    text-align: center;
+}
+
+h1 {
+    font-size: 5rem;
+}
+
+a {
+    color: #ffad70;
+    text-decoration: none;
+    transition: color .2s;
+}
+
+a:hover {
+    color: #ff657d;
+    transition: color .2s;
+}
+
+header {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: center;
+    height: 7rem;
+    box-shadow: 0 4px 6px -1px #0000001a,0 2px 4px -2px #0000001a;
+}
+
+header nav {
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+}
+
+header nav a {
+    margin: .5rem 1rem;
+}
+
+header nav a:not(:last-of-type)::after {
+    content: "|";
+    margin-left: 2rem;
+    color: #dedff6;
+}
+
+main {
+    height: calc(100vh - 14rem);
+    align-items: center;
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+}
+
+main > section {
+    width: 50%;
+}
+
+footer {
+    display: flex;
+    flex-flow: row wrap;
+    align-items: center;
+    justify-content: center;
+    height: 7rem;
+}
+
+footer > p {
+    margin: 0;
+    padding-top: 1.3rem;
+    border-top: 1px solid #dedff61a;
+    width: 60%;
+}
+
+footer span {
+    color: #ef4444;
+    margin: 0 .5rem;
+}
+
+footer a {
+    color: #dedff6;
+}
+
+footer a:hover {
+    color: #dedff6;
+    text-decoration: underline;
+}
+
+.logo {
+    width: fit-content;
+    margin: 0 auto;
+}
+
+.logo > img {
+    max-height: 180px;
+}
+
+.text-gradient {
+    background-color: #ffad70;
+    background-image: linear-gradient(45deg, #ffad70, #ff657d);
+    -webkit-background-clip: text;
+    -webkit-text-fill-color: transparent;
+    -moz-background-clip: text;
+    -moz-text-fill-color: transparent;
+    background-clip: text;
+    width: fit-content;
+    padding-bottom: .2em;
+    margin: 0 auto;
+}
+
+.doc-links {
+    margin-top: 6rem;
+}
+
+.btn, .btn-outline {
+    font-weight: 700;
+    font-size: 2rem;
+    border-radius: 3.4rem;
+    margin: 1rem;
+    padding: 2rem 2rem;
+    transition: all .2s;
+}
+
+.btn {
+    color: oklch(15.092% .036 346.812);
+    background-color: #ffad70;
+}
+
+.btn:hover {
+    color: oklch(15.092% .036 346.812);
+    background-color: #c68755;
+    transition: all .2s;
+}
+
+.btn-outline {
+    color: #ffad70;
+    border: 1px solid #ffad70;
+}
+
+.btn-outline:hover {
+    color: oklch(15.092% .036 346.812);
+    background-color: #ffad70;
+    transition: all .2s;
+}

package/template/src/controller/UserController.ts

@@ -16,7 +16,7 @@ import { User } from "@entity/User"
 
 @Route({ path: "/user", middlewares: [isAuthenticated] })
 export class UserController extends Controller {
-  @Get({ path: "/all" })
+  @Get({ path: "/" })
   async list(): Promise<void> {
     try {
       const users = (await this.userRepository.findAll()).map((user: User) => {

package/template/src/server.ts

@@ -1,6 +1,7 @@
 import "reflect-metadata"
 
 import { Config, cors, createServer, LyraConsole, SecurityConfig } from "@lyra-js/core"
+import { router } from "@router/index"
 import bcrypt from "bcrypt"
 import * as dotenv from "dotenv"
 import jwt from "jsonwebtoken"
@@ -46,6 +47,9 @@ app.serveStatic("/assets", {
   root: "public/assets"
 })
 
+// Mount manual routes (static controllers registered via router files)
+app.use(router)
+
 // Controllers are auto-discovered and registered from src/controller directory
 // Repositories and Services are auto-injected via DIContainer
 app.listen(port, () => {

package/template/src/templates/ExampleRender.tsx

@@ -1,19 +1,23 @@
-import { Base } from "@app/templates/layout/Base"
+import { Base } from "./layout/Base"
 
-export default function ExampleRender({
-  title,
-  content,
-  documentationUrl
-}: {
-  title: string
-  content: string
-  documentationUrl: string
-}) {
+export default function ExampleRender({ title, content }: { title: string; content: string }) {
   return (
     <Base>
       <section>
-        <h1>{title}</h1>
+        <figure className="logo">
+          <img src="/assets/logo.png" alt="LyraJS logo" />
+        </figure>
+        <h1 className="text-gradient">LyraJS</h1>
+        <h2>{title}</h2>
         <p>{content}</p>
+        <p className="doc-links">
+          <a href="https://lyrajs.dev/documentation/ssr#overview" target="_blank" className="btn">
+            SSR Documentation
+          </a>
+          <a href="https://lyrajs.dev/documentation" target="_blank" className="btn-outline">
+            Full Documentation
+          </a>
+        </p>
       </section>
     </Base>
   )

package/template/src/templates/layout/Base.tsx

@@ -1,6 +1,7 @@
 import { PropsWithChildren } from "@lyra-js/core"
-import { Footer } from "@templates/layout/Footer"
-import { Header } from "@templates/layout/Header"
+
+import { Footer } from "./Footer"
+import { Header } from "./Header"
 
 export function Base({ children }: PropsWithChildren) {
   return (
@@ -8,6 +9,7 @@ export function Base({ children }: PropsWithChildren) {
       <head>
         <meta charset="UTF-8" />
         <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <link rel="icon" href="/assets/logo.png" />
         <title>LyraJS App</title>
         <link rel="stylesheet" href="/assets/styles/app.css" />
       </head>

package/template/src/templates/layout/Footer.tsx

@@ -1,7 +1,11 @@
 export const Footer = () => {
   return (
     <footer>
-      <p>Footer</p>
+      <p>
+        Built with
+        <span>&#10084;</span>
+        by <a href="https://dev-way.eu">Devway</a>
+      </p>
     </footer>
   )
 }

package/template/src/templates/layout/Header.tsx

@@ -2,17 +2,8 @@ export const Header = () => {
   return (
     <header>
       <nav>
-        <ul>
-          <li>
-            <a href="/">Home</a>
-          </li>
-          <li>
-            <a href="/about">About</a>
-          </li>
-          <li>
-            <a href="/contact">Contact</a>
-          </li>
-        </ul>
+        <a href="/example/ssr-static">Static methods SSR</a>
+        <a href="/example/ssr">Decoratorated methods SSR</a>
       </nav>
     </header>
   )