From c936670573fdb7bc3726cbbb174f7068a7a640ad Mon Sep 17 00:00:00 2001 From: Mulanga Date: Thu, 12 Mar 2026 18:01:35 +0200 Subject: [PATCH] update readme --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 45 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fcf1ff7..1c31c4d 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,52 @@ A shift management application for scheduling staff, tracking attendance, and ge ## Quick Start -### Prerequisites -- Docker & Docker Compose +## Prerequisites -### Setup +- [Docker Desktop](https://www.docker.com/products/docker-desktop) installed +- [Docker Compose](https://docs.docker.com/compose/) (usually included with Docker Desktop) + +## Quick Start + +1. **Clone the repository:** + ```sh + git clone + cd bhoza-shift-manager + ``` + +2. **Copy the example environment file:** + ```sh + cp src/.env.example src/.env + # Or manually create src/.env based on src/.env.example + ``` + +3. **Start the app with MariaDB:** + ```sh + docker-compose --profile mysql up -d + ``` + This will start the app, Nginx, MariaDB, Redis, and Mailpit containers. + +4. **Install Composer dependencies:** + ```sh + docker-compose exec app composer install + ``` + +5. **Generate the application key:** + ```sh + docker-compose exec app php artisan key:generate + ``` + +6. **Run database migrations and seeders:** + ```sh + docker-compose exec app php artisan migrate --seed + ``` + +7. **Access the app:** + - Web: [http://localhost:8080](http://localhost:8080) + - Admin: [http://localhost:8080/admin/login](http://localhost:8080/admin/login) + - Mailpit: [http://localhost:8025](http://localhost:8025) + +### Setup(I think you should run the one above 🤷🏿‍♂️) ```bash git clone bhoza-shift-manager