This README provides a quick guide to set up and run a project using the Inertia.js stack. Inertia combines the best of both server-side and client-side frameworks to create a smooth, modern web development experience.
Before you begin, make sure you have the following installed on your system:
- PHP (7.4 or higher)
- Composer
- Node.js (LTS version)
- NPM or Yarn
- Laravel CLI
-
Clone the repository:
git clone <repository_url>
-
Navigate to the project directory:
cd <project_directory>
-
Install PHP dependencies:
composer install
-
Install JavaScript dependencies:
npm install # or yarn
-
Copy the
.env
file:cp .env.example .env
-
Generate application key:
php artisan key:generate
-
Configure your database in the
.env
file: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
-
Migrate the database:
php artisan migrate
-
Generate Ziggy file
php artisan ziggy:generate
-
Start the development server:
php artisan serve
-
Open your browser and visit http://localhost:8000.
The project is set up to use Inertia.js and Vue.js by default. Inertia allows you to build single-page apps without building an API. Components are written using Vue.js.
- Inertia.js: https://inertiajs.com/
- Vue.js: https://vuejs.org/
-
Compile assets (CSS/JS):
npm run dev
-
Run tests:
php artisan test
Feel free to contribute to this project by opening issues or submitting pull requests. Make sure to follow the project's coding standards.
This project is open-source and available under the MIT License.