This README provides a step-by-step guide on how to install and setup project. Please follow the instructions below to get started.
Before you begin, ensure that you have the following installed on your local development environment:
- PHP >= 8.1
- Composer
Clone the project repository to your local machine & Navigate to the project directory:
cd project
Install PHP dependencies using Composer:
composer install
Create a new .env
file using the example provided:
cp .env.example .env
Open the .env
file and update the environment variables as required, such as your database credentials:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database_name
DB_USERNAME=your_database_user
DB_PASSWORD=your_database_password
Generate a new application key:
php artisan key:generate
Migrate and seed the database:
php artisan migrate --seed
Start the Laravel development server:
php artisan serve
Visit http://127.0.0.1:8000
in your web browser to access the application.
Please refer to the CONTRIBUTING.md file for guidelines on how to contribute to this project.
This project is licensed under the MIT License.