arcanajs 0.2.2 → 1.0.0

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/README.md

@@ -1,284 +1,115 @@
-# Arcana.js
-
-<p align="center">
-  <img src="https://digiclips.ma/ArcanaJS.png" alt="Arcana.js Logo" width="200" height="200">
-</p>
-
-<p align="center">
-  A powerful full-stack framework combining Express, React, and MongoDB with server-side rendering
-</p>
-
-<p align="center">
-  <a href="#features">Features</a> •
-  <a href="#installation">Installation</a> •
-  <a href="#quick-start">Quick Start</a> •
-  <a href="#architecture">Architecture</a> •
-  <a href="#routing">Routing</a> •
-  <a href="#documentation">Documentation</a> •
-  <a href="#examples">Examples</a> •
-  <a href="#contributing">Contributing</a> •
-  <a href="#license">License</a>
-</p>
-
-## Overview
-
-Arcana.js is a comprehensive full-stack JavaScript framework built on top of Express.js and React, designed to create scalable, maintainable web applications with server-side rendering capabilities. By leveraging MongoDB and Mongoose, it provides a complete solution for modern web development following best practices in software architecture.
-
-## Features
-
-- **Express.js Backend**: Fast, unopinionated, minimalist web framework as the foundation
-- **React Frontend**: Component-based UI with server-side rendering out of the box
-- **MongoDB & Mongoose**: Powerful data modeling and integration with MongoDB
-- **MVC Architecture**: Clean separation of concerns with Model-View-Controller pattern
-- **OOP Principles**: Object-oriented design throughout the codebase
-- **Repository Pattern**: Abstraction layer between data access and business logic
-- **Server-Side Rendering**: Improved performance and SEO capabilities
-- **Scalable Architecture**: Designed to grow with your application needs
-- **TypeScript Support**: Optional static typing for better developer experience
-- **Built-in Middleware**: Common functionality pre-configured
-- **Elegant Routing System**: Declarative and flexible route definition
-
-## Installation
-
-```bash
-# Install Arcana.js CLI globally
-npm install -g arcana-cli
-
-# Create a new Arcana.js project
-arcana create my-awesome-app
-
-# Navigate to project directory
-cd my-awesome-app
-
-# Install dependencies
-npm install
-
-# Start development server
-npm run dev
-```
-
-## Quick Start
-
-After installation, your application will be running at `http://localhost:3000`.
-
-```javascript
-// Example controller: src/controllers/UserController.js
-import { Controller } from 'arcana/core';
-import { UserRepository } from '../repositories/UserRepository';
-
-export class UserController extends Controller {
-  constructor() {
-    super();
-    this.userRepository = new UserRepository();
-  }
-
-  async index(req, res) {
-    const users = await this.userRepository.findAll();
-    return this.render('users/index', { users });
-  }
-
-  async show(req, res) {
-    const user = await this.userRepository.findById(req.params.id);
-    return this.render('users/show', { user });
-  }
-}
-```
-
-## Architecture
-
-Arcana.js follows the MVC (Model-View-Controller) architecture with a strong emphasis on the repository pattern:
-
-```
-my-awesome-app/
-├── config/               # Application configuration
-├── public/               # Static assets
-├── src/
-│   ├── controllers/      # Route controllers
-│   ├── models/           # Mongoose models
-│   ├── repositories/     # Data access layer
-│   ├── services/         # Business logic
-│   ├── views/            # React components for SSR
-│   │   ├── layouts/      # Layout components
-│   │   └── pages/        # Page components
-│   └── routes/           # Route definitions
-├── tests/                # Test files
-├── .env                  # Environment variables
-├── .gitignore
-├── package.json
-└── arcana.config.js      # Arcana.js configuration
-```
-
-## Routing
-
-Arcana.js provides a powerful and flexible routing system that integrates seamlessly with controllers. Routes are defined in dedicated router files and automatically linked to controller methods.
-
-### Basic Router Configuration
-
-```javascript
-// src/routes/userRoutes.js
-import { Router } from 'arcana/core';
-import { UserController } from '../controllers/UserController';
-
-const userController = new UserController();
-const router = new Router();
-
-// Define routes and link to controller methods
-router.get('/users', userController.index);
-router.get('/users/:id', userController.show);
-router.post('/users', userController.create);
-router.put('/users/:id', userController.update);
-router.delete('/users/:id', userController.delete);
-
-export default router;
-```
-
-### Route Groups and Middleware
+<div align="center">
+  <img src="https://digiclips.ma/arcanajs.png" alt="ArcanaJS Logo" width="200" style="border-radius: 9px;"/>
+  
+  <p><strong>ArcanaJS A modern, full-stack JavaScript framework for building fast, SEO-friendly web applications</strong></p>
 
-```javascript
-// src/routes/apiRoutes.js
-import { Router } from 'arcana/core';
-import { authMiddleware } from '../middleware/auth';
+[![npm version](https://img.shields.io/npm/v/arcanajs.svg?style=flat-square)](https://www.npmjs.com/package/arcanajs)
+[![license](https://img.shields.io/npm/l/arcanajs.svg?style=flat-square)](https://github.com/arcanajs/arcanajs/blob/main/LICENSE)
+[![downloads](https://img.shields.io/npm/dm/arcanajs.svg?style=flat-square)](https://www.npmjs.com/package/arcanajs)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/arcanajs/arcanajs/ci.yml?style=flat-square)](https://github.com/arcanajs/arcanajs/actions)
 
-const router = new Router();
+[Website](https://arcanajs.com) • [Documentation](https://arcanajs.com/docs) • [Examples](https://github.com/arcanajs/examples) • [Community](https://discord.gg/zkFDewQ7TW)
 
-// Apply middleware to a group of routes
-router.group('/api', [authMiddleware], (r) => {
-  // These routes will all be prefixed with '/api' and use authMiddleware
-  r.use('/users', require('./userRoutes'));
-  r.use('/posts', require('./postRoutes'));
-});
+</div>
 
-export default router;
-```
+## 📚 Documentation
 
-### Registering Routes
+Comprehensive guides, API references, and tutorials are available at: **[https://arcanajs.com/docs](https://arcanajs.com/docs)**
 
-```javascript
-// src/app.js
-import { Application } from 'arcana/core';
-import userRoutes from './routes/userRoutes';
-import apiRoutes from './routes/apiRoutes';
+## 🤝 Contributing
 
-const app = new Application();
+We welcome contributions from the community! Whether it's:
 
-// Register routes
-app.useRoutes([
-  userRoutes,
-  apiRoutes
-]);
+- 🐛 **Bug reports** – Help us identify and fix issues
+- 💡 **Feature requests** – Share your ideas for improvements
+- 📝 **Documentation** – Improve or translate our docs
+- 🔧 **Code contributions** – Submit bug fixes or new features
 
-app.listen(3000);
-```
+### How to Contribute
 
-### Route Parameters and Validation
+1. **Fork** the repository
+2. **Create** a feature branch:
+   ```bash
+   git checkout -b feature/amazing-feature
+   ```
+3. **Commit** your changes:
+   ```bash
+   git commit -m "feat: add amazing feature"
+   ```
+4. **Push** to your branch:
+   ```bash
+   git push origin feature/amazing-feature
+   ```
+5. **Open** a Pull Request
 
-```javascript
-// Advanced routing with parameter validation
-router.get('/products/:category/:id', productController.show)
-  .where('category', /^[a-z-]+$/)
-  .where('id', /^\d+$/);
-```
+### Contribution Guidelines
 
-### Named Routes
+- Follow the existing code style and conventions
+- Write clear commit messages (we use [Conventional Commits](https://www.conventionalcommits.org/))
+- Add tests for new features
+- Update documentation as needed
+- Ensure all tests pass before submitting PR
 
-```javascript
-// Define a named route for easy URL generation
-router.get('/dashboard', dashboardController.index, 'dashboard.index');
+Refer to our [Contributing Guidelines](CONTRIBUTING.md) for detailed information.
 
-// Generate URL in your code or templates
-const dashboardUrl = router.namedRoute('dashboard.index');
-```
+---
 
-## Documentation
+## 💬 Community
 
-For detailed documentation, visit [docs.arcanajs.com](https://docs.arcanajs.com)
+Join our growing community:
 
-### Core Concepts
+- **Discord** – [Join our Discord server](https://discord.gg/zkFDewQ7TW) for discussions and support
+- **Twitter** – Follow [@ArcanaJS](https://twitter.com/arcanajs) for updates
+- **Stack Overflow** – Tag your questions with `arcanajs`
+- **GitHub Discussions** – [Start a discussion](https://github.com/arcanajs/arcanajs/discussions)
 
-- **Models**: Define your data structure using Mongoose schemas
-- **Views**: Create React components for rendering
-- **Controllers**: Handle HTTP requests and control flow
-- **Repositories**: Abstract data access operations
-- **Services**: Implement business logic
-- **Middlewares**: Process requests before they reach controllers
-- **Routers**: Define application routes and connect them to controllers
+## 🙏 Acknowledgments
 
-## Examples
+ArcanaJS is built on the shoulders of giants. Special thanks to:
 
-### Creating a Model
+- The **React** team for the amazing UI library
+- The **Express** community for the robust web framework
+- The **MongoDB** team for the flexible database
+- All our [contributors](https://github.com/arcanajs/arcanajs/graphs/contributors) who make this project better
 
-```javascript
-// src/models/User.js
-import { Model, Schema } from 'arcana/db';
+### Inspiration
 
-const userSchema = new Schema({
-  username: { type: String, required: true, unique: true },
-  email: { type: String, required: true, unique: true },
-  password: { type: String, required: true },
-  createdAt: { type: Date, default: Date.now },
-  updatedAt: { type: Date, default: Date.now }
-});
+ArcanaJS draws inspiration from excellent frameworks like:
 
-export const User = Model('User', userSchema);
-```
+- [NestJS](https://nestjs.com/) – Progressive Node.js framework
+- [Laravel](https://laravel.com/) – PHP framework with elegant syntax
 
-### Creating a Repository
+---
 
-```javascript
-// src/repositories/UserRepository.js
-import { Repository } from 'arcana/core';
-import { User } from '../models/User';
+## 👨‍💻 Author
 
-export class UserRepository extends Repository {
-  constructor() {
-    super(User);
-  }
+<div align="center">
+  <img src="https://github.com/mohammed-ben-cheikh.png" width="100" style="border-radius: 50%;" alt="Mohammed Ben Cheikh"/>
   
-  async findByUsername(username) {
-    return this.model.findOne({ username });
-  }
-}
-```
-
-### Creating a View Component
-
-```jsx
-// src/views/pages/users/Index.jsx
-import React from 'react';
-import { Page } from 'arcana/view';
-
-export default function UsersIndex({ users }) {
-  return (
-    <Page title="All Users">
-      <h1>Users</h1>
-      <ul>
-        {users.map(user => (
-          <li key={user._id}>
-            <a href={`/users/${user._id}`}>{user.username}</a>
-          </li>
-        ))}
-      </ul>
-    </Page>
-  );
-}
-```
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
-## License
-
-This project is licensed under the MIT License - see the LICENSE file for details.
+  **Mohammed Ben Cheikh**
+  
+  Full-Stack Developer & Framework Architect
+  
+  [![Website](https://img.shields.io/badge/Website-mohammedbencheikh.com-blue?style=flat-square)](https://mohammedbencheikh.com)
+  [![Email](https://img.shields.io/badge/Email-mohammed.bencheikh.dev@gmail.com-red?style=flat-square)](mailto:mohammed.bencheikh.dev@gmail.com)
+  [![GitHub](https://img.shields.io/badge/GitHub-@mohammed--ben--cheikh-black?style=flat-square)](https://github.com/mohammed-ben-cheikh)
+  [![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?style=flat-square)](https://linkedin.com/in/mohammed-ben-cheikh)
+</div>
 
 ---
 
-<p align="center">
-  Made with ❤️ by the Arcana.js Team
-</p>
+<div align="center">
+  <p><strong>Made with ❤️ and dedication by <a href="https://mohammedbencheikh.com">Mohammed Ben Cheikh</a></strong></p>
+  
+  <p>If you find <strong>ArcanaJS</strong> useful, please consider:</p>
+  
+  ⭐ **[Starring the project](https://github.com/arcanajs/arcanajs)** on GitHub
+  
+  🐦 **[Following us](https://twitter.com/arcanajs)** on Twitter
+  
+  💖 **[Sponsoring the project](https://github.com/sponsors/arcanajs)** to support development
+  
+  ---
+  
+  <sub>© 2025 ArcanaJS. All rights reserved.</sub>
+</div>

package/arcanajs-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}

package/eslint.config.mjs

@@ -0,0 +1,35 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      "prettier/prettier": ["error", { endOfLine: "auto" }],
+    },
+  },
+);

package/jest.config.mjs

@@ -0,0 +1,8 @@
+export default {
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.js$": "babel-jest",
+  },
+  transformIgnorePatterns: ["/node_modules/(?!(uuid)/)"],
+  testMatch: ["**/test/**/*.test.js"],
+};

package/package.json

@@ -5,52 +5,8 @@
     "email": "mohammed.bencheikh.dev@gmail.com",
     "url": "https://mohammedbencheikh.com/"
   },
-  "version": "0.2.2",
+  "version": "1.0.0",
   "description": "A powerful full-stack framework combining Express, React and MongoDB with server-side rendering",
-  "main": "dist/server.js",
-  "types": "dist/server.d.ts",
-  "files": [
-    "dist",
-    "bin"
-  ],
-  "scripts": {
-    "clean": "rm -rf dist",
-    "build": "tsc -p tsconfig.json",
-    "build:watch": "tsc -p tsconfig.json --watch",
-    "prepare": "npm run build",
-    "typecheck": "tsc -p tsconfig.json --noEmit",
-    "pack:verify": "npm pack --dry-run",
-    "dev": "nodemon --watch src --exec ts-node src/server.ts",
-    "start": "node dist/server.js",
-    "lint": "eslint . || true",
-    "test": "jest --runInBand"
-  },
-  "peerDependencies": {
-    "react": ">=16 <20",
-    "react-dom": ">=16 <20"
-  },
-  "dependencies": {
-    "dotenv": "^16.0.0",
-    "express": "^4.18.2",
-    "mongoose": "^7.0.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "url-join": "^5.0.0"
-  },
-  "devDependencies": {
-    "@types/dotenv": "^6.1.1",
-    "@types/express": "^5.0.5",
-    "@types/mongoose": "^5.11.96",
-    "@types/node": "^20.0.0",
-    "@types/react": "^18.2.0",
-    "@types/react-dom": "^18.2.0",
-    "@types/url-join": "^4.0.3",
-    "eslint": "^8.0.0",
-    "jest": "^29.0.0",
-    "nodemon": "^3.0.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.2.0"
-  },
   "keywords": [
     "framework",
     "full-stack",
@@ -65,17 +21,11 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/Mohammed-Ben-Cheikh/arcanajs.git"
+    "url": "https://github.com/arcanajs/arcanajs.git"
   },
   "bugs": {
-    "url": "https://github.com/Mohammed-Ben-Cheikh/arcanajs/issues"
-  },
-  "homepage": "https://github.com/Mohammed-Ben-Cheikh/arcanajs#readme",
-  "bin": {
-    "arcana": "dist/bin/arcana.js"
-  },
-  "engines": {
-    "node": ">=16"
+    "url": "https://github.com/arcanajs/arcanajs/issues"
   },
+  "homepage": "https://arcanajs.com",
   "license": "MIT"
-}
+}