This project utilizes Laravel Sail for a development environment, providing a consistent and isolated experience with Docker containers.
Requirements:
- Docker Desktop installed (https://docs.docker.com/desktop/install/windows-install/: https://docs.docker.com/desktop/install/windows-install/)
- Basic understanding of Docker and Laravel
Getting Started:
-
Clone the repository:
git clone https://github.com/your-repo-url.git
-
Navigate to the project directory:
-
Copy the
.env.example
file and rename it to.env
: -
Build and start the containers:
./vendor/bin/sail up
-
Install PHP dependencies:
./vendor/bin/sail composer install
-
Install Node.js dependencies:
npn install
npn run dev
-
Run migration
./vendor/bin/sail artisan migrate
-
Run DB Seed
./vendor/bin/sail artisan db:seed
-
Access your application:
- Open your browser and visit http://localhost:8000.
- Refer to
docker-compose.yml
for other service ports (database, mail, etc.).
Available Commands:
sail up
: Start the containers in detached mode.sail down
: Stop and remove the containers.sail shell
: Connect to a shell in the app container.sail artisan ...
: Run Artisan commands within the app container.sail php ...
: Run PHP scripts within the app container.sail composer ...
: Run Composer commands within the app container.sail npm ...
: Run npm commands within the app container.
Project Specifics:
- Additional Notes: [If applicable, mention any unique aspects of your project setup or specific configurations]
- Database Credentials: Configure
.env
file with appropriate database credentials and other settings. - Testing: [Describe how to run tests within the Sail environment if applicable]
- Deployment: [Briefly explain deployment instructions if relevant]
Contributing:
- We welcome contributions! Please follow our contribution guidelines: [Link to guidelines if available]
- Report any issues or bugs: [Link to issue tracker if available]
License:
This project is licensed under the [Your Project License] license.
Additional Resources:
- Laravel Sail Documentation: https://laravel.com/docs/10.x/sail: https://laravel.com/docs/10.x/sail
- Sail Script Reference: https://laravel.com/docs/10.x/sail: https://laravel.com/docs/10.x/sail