generated from theradcoza/Laravel-Docker-Dev-Template
resolve sql port related errors
This commit is contained in:
110
src/README.md
110
src/README.md
@@ -1,66 +1,78 @@
|
||||
<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>
|
||||
|
||||
<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>
|
||||
</p>
|
||||
# Bhoza Shift Manager - Docker Setup
|
||||
|
||||
## About Laravel
|
||||
This guide explains how to set up and run the Bhoza Shift Manager app using Docker.
|
||||
|
||||
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:
|
||||
## Prerequisites
|
||||
|
||||
- [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).
|
||||
- [Docker Desktop](https://www.docker.com/products/docker-desktop) installed
|
||||
- [Docker Compose](https://docs.docker.com/compose/) (usually included with Docker Desktop)
|
||||
|
||||
Laravel is accessible, powerful, and provides tools required for large, robust applications.
|
||||
## Quick Start
|
||||
|
||||
## Learning Laravel
|
||||
1. **Clone the repository:**
|
||||
```sh
|
||||
git clone <your-repo-url>
|
||||
cd bhoza-shift-manager
|
||||
```
|
||||
|
||||
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.
|
||||
2. **Copy the example environment file:**
|
||||
```sh
|
||||
cp src/.env.example src/.env
|
||||
# Or manually create src/.env based on src/.env.example
|
||||
```
|
||||
|
||||
You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
|
||||
3. **Start the app with MariaDB:**
|
||||
```sh
|
||||
docker-compose --profile mysql up -d
|
||||
```
|
||||
This will start the app, Nginx, MariaDB, Redis, and Mailpit containers.
|
||||
|
||||
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of 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.
|
||||
4. **Install Composer dependencies:**
|
||||
```sh
|
||||
docker-compose exec app composer install
|
||||
```
|
||||
|
||||
## Laravel Sponsors
|
||||
5. **Generate the application key:**
|
||||
```sh
|
||||
docker-compose exec app php artisan key:generate
|
||||
```
|
||||
|
||||
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 Partners program](https://partners.laravel.com).
|
||||
6. **Run database migrations and seeders:**
|
||||
```sh
|
||||
docker-compose exec app php artisan migrate --seed
|
||||
```
|
||||
|
||||
### Premium Partners
|
||||
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)
|
||||
|
||||
- **[Vehikl](https://vehikl.com/)**
|
||||
- **[Tighten Co.](https://tighten.co)**
|
||||
- **[WebReinvent](https://webreinvent.com/)**
|
||||
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
|
||||
- **[64 Robots](https://64robots.com)**
|
||||
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
|
||||
- **[Cyber-Duck](https://cyber-duck.co.uk)**
|
||||
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
|
||||
- **[Jump24](https://jump24.co.uk)**
|
||||
- **[Redberry](https://redberry.international/laravel/)**
|
||||
- **[Active Logic](https://activelogic.com)**
|
||||
- **[byte5](https://byte5.de)**
|
||||
- **[OP.GG](https://op.gg)**
|
||||
## Useful Commands
|
||||
|
||||
## Contributing
|
||||
- **Stop all containers:**
|
||||
```sh
|
||||
docker-compose down
|
||||
```
|
||||
- **Rebuild containers after changes:**
|
||||
```sh
|
||||
docker-compose build --no-cache
|
||||
```
|
||||
- **Run tests:**
|
||||
```sh
|
||||
docker-compose exec app php artisan test
|
||||
# or
|
||||
docker-compose exec app vendor/bin/pest
|
||||
```
|
||||
|
||||
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
||||
## Troubleshooting
|
||||
|
||||
## Code of Conduct
|
||||
- If you get a database connection error, ensure MariaDB is running and your `.env` has `DB_HOST=mysql` and `DB_PORT=3306`.
|
||||
- If port 3306 is in use, the container maps MariaDB to another port (e.g., 3308). In that case, only host access changes; containers always use `3306` internally.
|
||||
- For other issues, check logs:
|
||||
```sh
|
||||
docker-compose logs --tail=100
|
||||
```
|
||||
|
||||
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).
|
||||
---
|
||||
For more details, see the `docker-compose.yml` and `src/.env.example` files.
|
||||
|
||||
Reference in New Issue
Block a user