Skip to content

Home

Jump to bottom
Dmitry Olegovich Sorokin (@sorydima) edited this page Sep 20, 2025 · 1 revision

MagicAI (AIPlatform) Wiki

🌐 Overview

  • Repository: REChain-Network-Solutions/AIPlatform

  • Codename / Product: MagicAI

  • Purpose: AI SaaS starter platform including landing page, dashboard, customization, and core AI features.

  • License: BSD 3-Clause

  • Languages: JavaScript (41.4%), PHP (27%), Blade (20%), CSS/SCSS/Sass (remaining)

🚀 Key Features

  • Landing Page & Dashboard: Out-of-the-box templates for SaaS presentation and operations.

  • Theme Customization: Change visual appearance with one click.

  • Extensions Support: Modular AI features via magicai-extentions.

  • Localization: Multi-language support via lang/.

  • Secure Foundation: Security policy included in SECURITY.md.

📂 Repository Structure

Path Description
.github/ GitHub workflows, issue templates
app/ Core application logic: controllers, models, services
bootstrap/ Initialization & environment bootstrapping
config/ Configuration files (app, DB, cache, etc.)
database/ Migrations, seeds, SQL dump (magicai.sql)
documents/ Documentation & project notes
lang/ Translation & localization files
magicai-extentions/ Custom AI extensions/plugins
packages/ External or internal packages/modules
public/ Public assets (CSS, JS, images)
resources/ Views, Blade templates, frontend resources
routes/ API & web routes
storage/ Logs, cached data, temporary files
tests/ Unit & integration tests

Other important files:

  • .env.example → environment template

  • composer.json / composer.lock → PHP dependencies

  • package.json / package-lock.json → JavaScript dependencies

  • vite.config.mjs → Vite frontend bundler config

  • phpunit.xml → PHPUnit test configuration

  • version.txt → Current app version

  • README.md, SECURITY.md → Documentation

⚙️ Installation & Setup

  1. Clone Repository

    git clone https://github.com/REChain-Network-Solutions/AIPlatform.git
cd AIPlatform

  2. Environment Setup

    cp .env.example .env
# edit DB credentials, API keys, etc.

  3. Install Dependencies

    composer install
npm install   # or yarn

  4. Database Setup

    php artisan migrate --seed
# optionally import magicai.sql

  5. Build Frontend

    npm run build   # or npm run dev for development

  6. Run Application

    php artisan serve

🧩 Architecture

  • Backend: Laravel-based (PHP + Blade templating)

  • Frontend: Tailwind CSS + Vite build system

  • Database: SQL migrations & schema (magicai.sql)

  • Extensions: Modular plug-ins via magicai-extentions

  • Localization: Multi-language system in lang/

  • Testing: PHPUnit for backend, potential JS tests

🔐 Security

  • Security guidelines in SECURITY.md

  • BSD 3-Clause license

  • .env file for sensitive configs (DB, API keys)

  • Recommend HTTPS + reverse proxy for production

📊 Project Status

  • Commits: ~7 (early development stage)

  • Releases: none published

  • Stars/Forks: minimal (early community adoption)

🌍 Usage Scenarios

  • SaaS startups needing ready AI landing + dashboard

  • Enterprises requiring multilingual AI interface

  • Developers launching branded AI tools with quick theme customization

  • Educational projects experimenting with AI SaaS architecture

📌 Roadmap (Suggested)

  • Publish first official release

  • Extend AI integrations (OpenAI, HuggingFace, local models)

  • Add CI/CD pipelines in .github/workflows/

  • Dockerize for production deployment

  • Expand automated test coverage

  • Create official documentation site

🧭 Summary

MagicAI (AIPlatform) is a flexible AI SaaS starter kit offering a complete landing + dashboard solution, fast theming, localization, and extensibility. Though early in development, it provides a strong base for building scalable AI-powered applications.

# MagicAI (AIPlatform) Wiki

🌐 Overview

🚀 Key Features

  • Landing Page & Dashboard: Out-of-the-box templates for SaaS presentation and operations.
  • Theme Customization: Change visual appearance with one click.
  • Extensions Support: Modular AI features via magicai-extentions.
  • Localization: Multi-language support via lang/.
  • Secure Foundation: Security policy included in SECURITY.md.

📂 Repository Structure

Path Description
.github/ GitHub workflows, issue templates
app/ Core application logic: controllers, models, services
bootstrap/ Initialization & environment bootstrapping
config/ Configuration files (app, DB, cache, etc.)
database/ Migrations, seeds, SQL dump (magicai.sql)
documents/ Documentation & project notes
lang/ Translation & localization files
magicai-extentions/ Custom AI extensions/plugins
packages/ External or internal packages/modules
public/ Public assets (CSS, JS, images)
resources/ Views, Blade templates, frontend resources
routes/ API & web routes
storage/ Logs, cached data, temporary files
tests/ Unit & integration tests

Other important files:

  • .env.example → environment template
  • composer.json / composer.lock → PHP dependencies
  • package.json / package-lock.json → JavaScript dependencies
  • vite.config.mjs → Vite frontend bundler config
  • phpunit.xml → PHPUnit test configuration
  • version.txt → Current app version
  • README.md, SECURITY.md → Documentation

⚙️ Installation & Setup

  1. Clone Repository

    git clone https://github.com/REChain-Network-Solutions/AIPlatform.git
cd AIPlatform

  2. Environment Setup

    cp .env.example .env
# edit DB credentials, API keys, etc.

  3. Install Dependencies

    composer install
npm install   # or yarn

  4. Database Setup

    php artisan migrate --seed
# optionally import magicai.sql

  5. Build Frontend

    npm run build   # or npm run dev for development

  6. Run Application

    php artisan serve

🧩 Architecture

  • Backend: Laravel-based (PHP + Blade templating)
  • Frontend: Tailwind CSS + Vite build system
  • Database: SQL migrations & schema (magicai.sql)
  • Extensions: Modular plug-ins via magicai-extentions
  • Localization: Multi-language system in lang/
  • Testing: PHPUnit for backend, potential JS tests

🔐 Security

  • Security guidelines in SECURITY.md
  • BSD 3-Clause license
  • .env file for sensitive configs (DB, API keys)
  • Recommend HTTPS + reverse proxy for production

📊 Project Status

  • Commits: ~7 (early development stage)
  • Releases: none published
  • Stars/Forks: minimal (early community adoption)

🌍 Usage Scenarios

  • SaaS startups needing ready AI landing + dashboard
  • Enterprises requiring multilingual AI interface
  • Developers launching branded AI tools with quick theme customization
  • Educational projects experimenting with AI SaaS architecture

📌 Roadmap (Suggested)

  • Publish first official release
  • Extend AI integrations (OpenAI, HuggingFace, local models)
  • Add CI/CD pipelines in .github/workflows/
  • Dockerize for production deployment
  • Expand automated test coverage
  • Create official documentation site

🧭 Summary

MagicAI (AIPlatform) is a flexible AI SaaS starter kit offering a complete landing + dashboard solution, fast theming, localization, and extensibility. Though early in development, it provides a strong base for building scalable AI-powered applications.

Clone this wiki locally