generated from theradcoza/Laravel-Docker-Dev-Template
Compare commits
2 Commits
shift-mana
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8bc6781e17 | ||
|
|
c936670573 |
48
README.md
48
README.md
@@ -28,10 +28,52 @@ A shift management application for scheduling staff, tracking attendance, and ge
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
### Prerequisites
|
## Prerequisites
|
||||||
- Docker & Docker Compose
|
|
||||||
|
|
||||||
### 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 <your-repo-url>
|
||||||
|
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(Maybe you should run the one above 🤷🏿♂️)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone <repo-url> bhoza-shift-manager
|
git clone <repo-url> bhoza-shift-manager
|
||||||
|
|||||||
Reference in New Issue
Block a user