Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 3.17 KB

README.md

File metadata and controls

59 lines (46 loc) · 3.17 KB
Raw

🚀 Laravel Breeze Starter

Laravel Breeze Starter is a versatile and open-source starter template that simplifies the development of Laravel applications. Perfect for both beginners and experienced developers, this starter kit integrates a suite of essential tools and technologies to jumpstart your project. With Laravel Breeze Starter, you can focus on crafting your unique application without the hassle of setting up authentication and other foundational features from scratch. Dive into building your next Laravel project today by cloning our repository!

🛠️ Technology Stack

Backend:

  • Laravel: The powerful framework providing the foundation of our starter kit.
  • Laravel Breeze: Streamlined starter kit for Laravel, offering basic authentication scaffolding.
  • PHP: The server-side scripting language that powers our backend.

Frontend:

  • Vite: Next Generation Frontend Tooling.
  • Tailwind CSS: A utility-first CSS framework for rapidly building custom designs.
  • Alpine.js: A minimal framework for composing JavaScript behavior in your markup.
  • DataTables: A jQuery JavaScript library for enhancing HTML table interaction.
  • jQuery: A fast, small, and feature-rich JavaScript library.

Database:

  • MySQL: The robust relational database we utilize for its reliability and efficiency.

📂 Directory Structure

  • /app: Contains the core code of the application.
  • /database: Houses database migrations, factories, and seeders.
  • /public: Publicly accessible files.
  • /resources: Views, raw CSS, and JavaScript.
  • /routes: Application routes.
  • /tests: Application tests.

🚀 Getting Started

Prerequisites:

  • PHP >= 8.2
  • Composer
  • Node.js & npm
  • A MySQL database

Installation:

  1. Clone the repository to your local machine.
  2. Install the PHP dependencies using Composer: composer install.
  3. Install the JavaScript dependencies using npm: npm install.
  4. Run the JavaScript build process using npm: npm run build or run the JavaScript build server with npm: npm run dev.
  5. Copy the .env.example file to a new file named .env and configure your database credentials.
  6. Generate an application key: php artisan key:generate.
  7. Run the database migrations: php artisan migrate.
  8. Start the development server: php artisan serve.
  9. Optionally, there are several commands for managing the project that you can find by typing php artisan app

💡 Features

  • Streamlined authentication setup allowing you to focus on your application's unique features.
  • Rapid development cycle with pre-configured tools.
  • Easily extendable and customizable to fit your specific needs.

🤝 How to Contribute

We value your contributions. To get started, please fork the repository and open a pull request with your changes so that they can be reviewed and merged.

Begin your Laravel application development journey with the Laravel Breeze Starter!