-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
73 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,77 @@ | ||
| <p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p> | ||
| <h1 align="center"> ZagreusCMS </h1> | ||
| <p align="center">Modular, and easy-to-use CMS that built under Laravel 10. </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a> | ||
| <a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a> | ||
| <a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a> | ||
| <a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a> | ||
| <img src="https://img.shields.io/badge/php-8.1-green.svg"> | ||
| <img src="https://img.shields.io/github/stars/zagreus-co/ZagreusCMS.svg"> | ||
| <img src="https://img.shields.io/github/release/zagreus-co/ZagreusCMS.svg"> | ||
| <img src="https://img.shields.io/github/issues/zagreus-co/ZagreusCMS.svg"> | ||
| </p> | ||
|
|
||
| ## About Laravel | ||
|
|
||
| Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as: | ||
|
|
||
| - [Simple, fast routing engine](https://laravel.com/docs/routing). | ||
| - [Powerful dependency injection container](https://laravel.com/docs/container). | ||
| - Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. | ||
| - Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). | ||
| - Database agnostic [schema migrations](https://laravel.com/docs/migrations). | ||
| - [Robust background job processing](https://laravel.com/docs/queues). | ||
| - [Real-time event broadcasting](https://laravel.com/docs/broadcasting). | ||
|
|
||
| Laravel is accessible, powerful, and provides tools required for large, robust applications. | ||
|
|
||
| ## Learning Laravel | ||
|
|
||
| Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. | ||
|
|
||
| You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch. | ||
|
|
||
| If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 2000 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library. | ||
|
|
||
| ## Laravel Sponsors | ||
|
|
||
| We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell). | ||
|
|
||
| ### Premium Partners | ||
|
|
||
| - **[Vehikl](https://vehikl.com/)** | ||
| - **[Tighten Co.](https://tighten.co)** | ||
| - **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** | ||
| - **[64 Robots](https://64robots.com)** | ||
| - **[Cubet Techno Labs](https://cubettech.com)** | ||
| - **[Cyber-Duck](https://cyber-duck.co.uk)** | ||
| - **[Many](https://www.many.co.uk)** | ||
| - **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)** | ||
| - **[DevSquad](https://devsquad.com)** | ||
| - **[Curotec](https://www.curotec.com/services/technologies/laravel/)** | ||
| - **[OP.GG](https://op.gg)** | ||
| - **[WebReinvent](https://webreinvent.com/?utm_source=laravel&utm_medium=github&utm_campaign=patreon-sponsors)** | ||
| - **[Lendio](https://lendio.com)** | ||
|
|
||
| ## Contributing | ||
|
|
||
| Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). | ||
|
|
||
| ## Security Vulnerabilities | ||
|
|
||
| If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed. | ||
|
|
||
| ## License | ||
|
|
||
| The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). | ||
| ### ⚡ Features and basic modules | ||
| * Analytic | ||
| * Multilingual blog | ||
| * Commenting | ||
| * Keyword | ||
| * In-page notification | ||
| * Key-value option management | ||
| * Meta tag Generator for better SEO | ||
| * Theming for both admin area and index | ||
|
|
||
| ### 🧩 Requirements | ||
| These are the only requirements you need to get ZagreusCMS up and running smoothly. | ||
| ``` | ||
| - php v8.1 or higher | ||
| - node v10.16.0 or higher | ||
| - npm 6.9.0 or higher | ||
| - git 2.17.1 or higher | ||
| - any kind of SQL database | ||
| ``` | ||
|
|
||
|
|
||
| ### 🔧 Instaltion | ||
|
|
||
| First your have to clone the repository on your machine or server | ||
| ```bash | ||
| $ git clone https://github.com/zagreus-co/ZagreusCMS.git | ||
| ``` | ||
|
|
||
| #### Using Docker | ||
| ```bash | ||
| # Start using docker-compose | ||
| $ docker-compose up | ||
| ``` | ||
| #### Run locally | ||
|
|
||
| 1. Create a database on your machine | ||
| 2. Rename `.env.example` to `.env` and put your database information* from lines 11 to 16 | ||
| 3. run the following commands | ||
| ```bash | ||
| # Download and install dependencies | ||
| $ composer install | ||
| $ npm install | ||
| $ npm run build | ||
| # Generate application key | ||
| $ php artisan key:generate | ||
| # Load migrations and seed database | ||
| $ php artisan migrate --seed | ||
| $ php artisan module:seed | ||
| $ php artisan zagreus:load-permissions | ||
| ``` | ||
| 4. Start your local server: | ||
| ```bash | ||
| # Using PHP Built-in server | ||
| $ php artisan serve | ||
|
|
||
| # Using Octane | ||
| $ php artisan octane:watch | ||
| ``` | ||
|
|
||
| 5. Enjoy :) | ||
|
|
||
| the basic sudo user credentials: `test@zagreus.company:123456` | ||
| * We highly recommend changing this user email and password! | ||
|
|
||
| ------------ | ||
|
|
||
| ##### Please note that ZagreusCMS is not built to be your primary Laravel CMS! it's a basic CMS boilerplate so you can modify and develop it in the way you want and build your Laravel projects! |