Mave CMS 🚀

🌐 Website • ✉️ Email • 💼 GitHub

A Flexible, Scalable, and Open-Source Headless CMS Built on MACH Architecture

---

🌟 About Mave CMS

Mave CMS is a flexible, scalable, and open-source headless Content Management System designed with modern web technologies and adhering to the MACH architecture principles. Tailored for developers and content creators, Mave CMS offers a versatile and collaborative platform for managing content across various applications.

---

🛠️ Features

1. Customizable Component-Based Page Builder

• Dynamic Page Builder: Add, edit, delete, and duplicate over 16 components seamlessly.
• Components Include:
  • Basic Components: Title, Paragraph, Media, Menu, Navbar, Slider, Card, Footer.
  • Pro Components: Video, Table, Accordion, Button, Gallery, Google Map, Icon List, Testimonial.
• Top Component Builders & Management: Menu Items, Menu, Navbar, Footer, Media Library, Card, Slider.

2. Robust Media Management

• Media Selection Modal: Select, upload, and integrate various media types with single and multiple selection modes.
• User-Friendly Interface: Smooth media handling without disrupting the workflow.

3. Advanced Features

• AI Chat Integration: "Talk to AI" feature for interactive assistance.
• DIY CMS: Custom model generator allowing users to tailor the CMS for specific needs like e-commerce, blogs, or news portals.
• Form Builder: Create and manage custom forms within the CMS.
• Doc to API: Converts user-written or uploaded YAML files into CMS pages automatically.

4. Technology Stack and CI/CD Pipeline Integration

• Frontend:
  • React & Next.js: Interactive and server-rendered interfaces.
  • Ant Design & Tailwind CSS: Consistent and responsive UI design.
  • Next.js Image Component: Optimizes image handling.
• Backend:
  • Laravel & MySQL: Robust backend operations and data management.
• Version Control: Hosted on a public GitHub repository to facilitate collaboration.
• CI/CD Pipeline:
  • Jenkins: Automated builds, tests, and deployments.
  • Hosted on Nginx Server: Secures Jenkins access and integrates with Github via webhooks.
  • Alternative Tools Considered: Drone CI and GitLab CI/CD, but Jenkins was selected for its flexibility.

5. Open-Source and MACH Architecture

• Microservices: Modular and independently operating components for scalability.
• API-First: Comprehensive APIs for easy integration with frontend frameworks and third-party services.
• Cloud-Native: Optimized for modern cloud infrastructures, ensuring high availability and resilience.
• Headless: Decouples backend management from frontend presentation, offering flexibility across platforms.

6. Collaboration and Customization

• Next.js Without TypeScript: Lower barrier to entry, allowing developers with basic Next.js knowledge to contribute.
• Public GitHub Repository: Encourages community collaboration and contributions.
• Well-Structured Documentation: Integrated within the CMS, providing guidelines for usage and collaboration.
• Theme Customization: Developers can create and customize themes to fit various design requirements.

7. Security and Best Practices

• Data Security: Secure credential storage, SSL certificates, role-based access control, and regular updates.
• Responsive Design: Ensures all components function correctly across different devices and screen sizes.
• Privacy Compliance: Adheres to GDPR and CCPA regulations, with a comprehensive privacy policy detailing data collection and usage.

---

📦 Installation

Minimum Requirements:

• CPU: 2 cores
• RAM: 4 GB
• Storage: 20 GB SSD
• Operating System: Ubuntu 18.04+, Windows 10+, macOS 10.15+
• Browser: Modern browsers with V8 engine (e.g., Google Chrome, Chromium)

Recommended Requirements:

• CPU: 4 cores
• RAM: 8 GB
• Storage: 50 GB SSD
• Operating System: Ubuntu 20.04+, Windows 11, macOS 11+
• Browser: Latest version of Google Chrome

Installation Steps:

1. Clone the Repository:

   git clone https://github.com/atiqisrak/mave-cms.git

2. Navigate to the Project Directory:

   cd mave-cms

3. Install Dependencies:

   npm install

4. Configure Environment Variables:
   • Duplicate .env.example to .env and update the necessary configurations.
5. Run Migrations:

   php artisan migrate

6. Start the Development Server:

   npm run dev

7. Access the CMS:
   • Open your browser and navigate to http://localhost:3000

---

🛠️ Technologies & Tools

---

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch

   git checkout -b feature/AmazingFeature

3. Commit your Changes

   git commit -m "Add some AmazingFeature"

4. Push to the Branch

   git push origin feature/AmazingFeature

5. Open a Pull Request

---

📄 License

Distributed under the MIT License. See LICENSE for more information.

---

📫 Get in Touch

---

---

⚡ Fun Fact

• 🤖 AI-Powered: Integrates AI for interactive assistance and enhanced user experience.
• 🌱 Community Driven: Open-source and built for collaboration, welcoming developers from around the world to contribute and innovate.