Skip to content

Commit

Permalink
update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
mayankjaviya committed Nov 18, 2023
1 parent 8b6e54c commit 56a952f
Showing 1 changed file with 24 additions and 13 deletions.
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# inertia-react-scaffold
# inertia-reactive-pms

A boilerplate project that combines Laravel 10 with Inertia.js and React for rapid web application development.
A robust task management application built on Laravel 10, Inertia.js, and React, featuring a dynamic Kanban board for efficient task organization.

![Project Screenshot](https://raw.githubusercontent.com/Mayank-Javiya/inertia-reactive-pms/main/public/images/Screenshot.png)

## Table of Contents

Expand All @@ -11,17 +13,26 @@ A boilerplate project that combines Laravel 10 with Inertia.js and React for rap

## Introduction

The inertia-react-scaffold is a powerful starting point for building dynamic web applications using Laravel 10, Inertia.js, React, and Vite. This boilerplate combines the best of both worlds: the robust backend capabilities of Laravel and the efficient, client-side interactivity of React, all while benefiting from the lightning-fast asset compilation provided by Vite.
Elevate your productivity with inertia-reactive-pms, a powerful task manager that seamlessly combines the backend capabilities of Laravel 10 with the interactivity of React and the efficiency of Vite. The inclusion of a dynamic Kanban board makes task organization a breeze, allowing you to manage your workflow with ease.

Whether you're a seasoned developer looking to streamline your workflow or a newcomer seeking a solid foundation for your web project, this boilerplate offers an array of features and a clean, well-structured codebase to accelerate your development journey. Get started quickly, customize to your heart's content, and build outstanding web applications with confidence.
Whether you're an experienced developer looking to streamline your task management or a newcomer seeking a solid foundation for your project, this application provides a clean, well-structured codebase and an array of features to enhance your task management experience. Get started quickly, customize as needed, and elevate your task management with confidence.

## Features

- **Laravel 10 Integration:** Built on top of Laravel 10.
- **Inertia.js and React:** Harness the power of Inertia.js and React for building modern, dynamic, and single-page applications with minimal client-side complexity.
- **Vite Asset Compilation:** Utilize Vite, a fast and efficient build tool, to compile your JavaScript and CSS assets. Vite offers rapid development and hot module replacement for an enhanced development experience.
- **Routing and Navigation:** Inertia.js allows for smooth client-side navigation without full-page reloads. You can easily define routes and handle navigation on the front end.
- **Sample Page and Component:** Get started quickly with sample pages and components to demonstrate how to build various parts of your application.
- **Inertia.js and React:** Harness the power of Inertia.js and React for building a modern, dynamic, and single-page task management application.
- **Vite Asset Compilation:** Utilize Vite, a fast and efficient build tool, to compile your JavaScript and CSS assets. Experience rapid development and hot module replacement for an enhanced development experience.
- **Kanban Board:** Effortlessly manage tasks with a dynamic Kanban board. Drag and drop tasks across customizable sections like Backlog, In Progress, Done, and Completed.
- **Routing and Navigation:** Inertia.js enables smooth client-side navigation without full-page reloads. Easily define routes and handle navigation on the front end.
- **Sample Page and Component:** Quickly get started with sample pages and components to showcase various aspects of your task management application.



## Built with inertia-react-scaffold

This project was created using [inertia-react-scaffold](https://github.com/Mayank-Javiya/inertia-react-scaffold), a boilerplate project that combines Laravel 10 with Inertia.js and React for rapid web application development.

Feel free to check out the scaffold project for more details and explore how it can accelerate your web development process.

## Prerequisites

Expand All @@ -34,22 +45,22 @@ Whether you're a seasoned developer looking to streamline your workflow or a new

```bash
# Clone the repository
git clone https://github.com/Mynk001/inertia-react-scaffold.git
git clone https://github.com/Mayank-Javiya/inertia-reactive-pms.git

# Change into the project directory
cd your-project
cd inertia-reactive-pms

# Install PHP dependencies
composer install

# Install JavaScript dependencies
npm install

# Run migrations to set up the database
php artisan migrate

# Compile assets
npm run dev

# Start the development server
php artisan serve
```

Take advantage of this boilerplate's comprehensive toolset and create web applications that are both feature-rich and efficient. Welcome to a faster, smoother, and more enjoyable development experience!

0 comments on commit 56a952f

Please sign in to comment.