docs: add comprehensive README for Car Repairs Shop
Some checks failed
linter / quality (push) Has been cancelled
tests / ci (push) Has been cancelled

This commit is contained in:
2025-07-30 17:23:11 +00:00
parent e839d40a99
commit 6b3baffc3e

69
README.md Normal file
View File

@ -0,0 +1,69 @@
# Car Repairs Shop
A modern Laravel-based application for managing car repair shop operations, built with Livewire, Volt, and Flux UI. This project streamlines customer management, appointments, inventory, service orders, technician management, and reporting.
## Features
- Customer and Vehicle Management
- Appointment Scheduling
- Service Orders and Estimates
- Inventory and Parts Tracking
- Technician Performance and Skills
- Timesheets and Work Orders
- Dashboard and Analytics
- Role-based Permissions
- Notifications
## Tech Stack
- **Backend:** Laravel 12, PHP 8.2
- **Frontend:** Livewire, Volt, Flux UI, Tailwind CSS, Vite
- **Database:** MySQL (default), SQLite (for testing)
- **Testing:** PHPUnit
## Installation
1. **Clone the repository:**
```bash
git clone https://git.safetracksystems.com/sackey/Car-Repairs-Shop.git
cd Car-Repairs-Shop
```
2. **Install PHP dependencies:**
```bash
composer install
```
3. **Install Node.js dependencies:**
```bash
npm install
```
4. **Copy environment file and set up keys:**
```bash
cp .env.example .env
php artisan key:generate
```
5. **Configure your database in `.env`**
6. **Run migrations and seeders:**
```bash
php artisan migrate --seed
```
7. **Build frontend assets:**
```bash
npm run build
```
8. **Start the development server:**
```bash
php artisan serve
```
## Usage
- Access the app at `http://localhost:8000`
- Login/register and start managing your car repair shop
## Testing
Run all tests with:
```bash
./vendor/bin/phpunit
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
MIT