phuong-w/marzbo-core

Marzbo

About This Project

This is the project for Marzbo by KHGC. This project is built with:

• Laravel
• Laravel Sanctum
• Spatie Media Library
• Spatie Laravel Permission
• Laravel Modules

Getting started

Prerequisites

• PHP ^8.1
• Latest Node.js version
• Docker
• Composer v2

Installing

Manual

# Clone the project and run composer


# Install the composer packages
composer install

# Copy the .env.example file to .env
cp .env.example .env

# Remember to setup your DB settings in .env
# Migration and DB seeder (after changing your DB settings in .env)
php artisan migrate --seed

With Docker

# Clone the project and run composer


# We need to copy the .env.example file to .env first (!!important)
cp .env.example .env

# Run the docker services
docker-compose up -d

Install Composer Packages

• Executing into bash

# Execute into workspace bash
docker-compose exec workspace bash

# Run the artisan or npm commands here
/var/www~ composer install

• Or you can execute commands without going into bash

# Get laravel docker container ID from containers list
docker ps

# Where <container ID> is the "workspace" container id, ex: c3ecb5baef0b
docker exec -it <container ID> composer install # or npm run watch

Final steps

Add marzbo.local to your hosts file.

Go to marzbo.local to access the website.

Running the tests

• Tests system is under development

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Authors

• Steven - Initial Work

License

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