README

SalamCMS is a lightweight Headless CMS built with PHP and MySQL.
It provides a simple yet flexible backend to manage content and expose it through RESTful APIs, so developers can build websites, apps, or services with any frontend framework.

✨ Features

🗂️ Headless architecture – decouple backend from frontend
🔑 Authentication system (JWT/session-based)
📦 Content management – define content types, create & manage entries
🌐 REST API to deliver content anywhere
⚡ Lightweight and easy to deploy (pure PHP + MySQL)
🔧 Extensible – can be customized or integrated with any PHP project

🚀 Installation

Requirements

PHP >= 8.0
MySQL >= 5.7
Web server (Apache/Nginx)
Composer (recommended)

Steps

Clone the repository:

git clone https://github.com/shaltoook/salamcms.git
cd salamcms

Install dependencies (if using Composer):
```
composer install
```

Create a database in MySQL:

CREATE DATABASE salamcms CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

Copy the example environment file:
```
cp .env.example .env
```
And update your DB credentials.
Run migrations (if available) or import database.sql:
```
mysql -u username -p salamcms < database.sql
```
Start your PHP server (for development):
```
php -S localhost:8000 -t public
```
Visit http://localhost:8000 🎉

📚 Usage

Access the Admin Panel at: /admin
Content is exposed via RESTful endpoints under: /api/...
Example:
```
GET /api/posts
GET /api/posts/{id}
```

🛠️ Roadmap

GraphQL support
Role-based access control
File & media management
Plugin system

🤝 Contributing

Contributions are welcome!

Fork the repository
Create a feature branch (git checkout -b feature/my-feature)
Commit your changes
Push to your fork and open a Pull Request

📄 License

This project is licensed under the MIT License – see the LICENSE file for details.

👤 Author

Developed by shaltoook

SalamCMS (فارسی)

SalamCMS یک سیستم مدیریت محتوای بدون واسط (Headless CMS) سبک و ساده است که با PHP و MySQL ساخته شده.
این پروژه یک بک‌اند انعطاف‌پذیر برای مدیریت محتوا فراهم می‌کند و از طریق APIهای REST محتوا را در اختیار فرانت‌اند یا اپلیکیشن‌ها قرار می‌دهد.

✨ امکانات

🗂️ معماری Headless — جداسازی بک‌اند از فرانت‌اند
🔑 سیستم احراز هویت (JWT یا Session)
📦 مدیریت محتوا — تعریف انواع محتوا و ساخت و مدیریت داده‌ها
🌐 APIهای REST برای ارائه محتوا در هر محیطی
⚡ سبک و قابل استقرار سریع (فقط PHP + MySQL)
🔧 قابل توسعه و قابل ادغام با هر پروژه‌ی PHP

🚀 نصب

نیازمندی‌ها

PHP نسخه 8 به بالا
MySQL نسخه 5.7 به بالا
وب‌سرور (Apache یا Nginx)
Composer (پیشنهادی)

مراحل نصب

کلون کردن مخزن:

git clone https://github.com/shaltoook/salamcms.git
cd salamcms

نصب وابستگی‌ها (در صورت استفاده از Composer):
```
composer install
```

ایجاد دیتابیس در MySQL:

CREATE DATABASE salamcms CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

کپی فایل تنظیمات نمونه:
```
cp .env.example .env
```
و سپس مشخصات دیتابیس خود را ویرایش کنید.
اجرای migrationها (اگر وجود دارد) یا وارد کردن فایل database.sql:
```
mysql -u username -p salamcms < database.sql
```
اجرای سرور PHP (برای توسعه):
```
php -S localhost:8000 -t public
```
بازدید از http://localhost:8000 🎉

📚 استفاده

پنل مدیریت: /admin
API برای محتوا: /api/...
نمونه:
```
GET /api/posts
GET /api/posts/{id}
```

🛠️ نقشه راه

پشتیبانی از GraphQL
مدیریت دسترسی مبتنی بر نقش (Role-based)
مدیریت فایل‌ها و رسانه‌ها
سیستم افزونه‌ها

🤝 مشارکت

از مشارکت شما استقبال می‌کنیم!

ریپازیتوری را Fork کنید
یک شاخه جدید بسازید (git checkout -b feature/my-feature)
تغییرات خود را commit کنید
روی Fork خود Push کرده و Pull Request باز کنید

📄 مجوز

این پروژه تحت مجوز MIT منتشر شده است — برای جزئیات بیشتر فایل LICENSE را ببینید.

👤 توسعه‌دهنده

توسعه داده شده توسط shaltoook

shaltoook / salamcms

Maintainers

Details