This is a starter kit for Laravel projects
The Laravel Starter Kit is a collection of tools and libraries designed to speed up the initial bootstrapping process for new Laravel projects. It includes several useful packages and tools that will help you get started quickly and easily developing web applications in Laravel.
[!IMPORTANT] Before contributing to the project, please, carefully read through this README document.
The Laravel Starter Kit includes the following packages and tools:
To run the project, you must first install PHP and the dependency manager Composer. Server requirements are as follows:
Follow these steps to install and set up your project:
[!NOTE] To streamline the installation process, we've provided a setup script,
./setup.sh
. This script is designed to automate the initial setup steps for a Laravel application, saving you time and ensuring a consistent setup.
Clone the repository:
git clone [email protected]:ideal-creative-lab/laravel-starter-kit.git
Navigate to the project directory:
cd laravel-starter-kit
Install PHP dependencies:
composer install
Copy and edit the environment file:
cp .env.example .env
Configure your database connection by editing the .env
file:
vim .env
Generate application key:
php artisan key:generate
Install necessary backend packages:
php artisan install:backend
Run migrations:
php artisan migrate
Install frontend stack:
php artisan install:frontend
[!WARNING] To avoid duplication, make sure you run the command once for a specific stack!
(Optional) Install the authentication component:
php artisan install:auth
Start the server:
php artisan serve
You should see a success message with the host and port of the running server, which is http://127.0.0.1:8000 by default.
[!NOTE] For hot reloading, you can use the package manager you selected in step 9.
After installation, you are ready to start developing your Laravel application. The Laravel Starter Kit provides a solid foundation and includes several packages to enhance your development experience.
You can use the Auto Deploy Github Action to deploy your project to Ploi. It will be triggered on push to main
branch, you can change it if you want.
The following steps will help you get started:
Repository
tab.Deploy Webhook URL
section.We welcome contributions from other developers. Please see CONTRIBUTING.md for ways to get started.
This project has been developed by the team of Ideal Creative Lab.
We would like to acknowledge the contributions of the Laravel community and the creators of the included packages.