Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyle-myre/inventory-management-system
CRUD Web application with Laravel Livewire and Filament.
https://github.com/kyle-myre/inventory-management-system
filament laravel livewire php vite vue
Last synced: 18 days ago
JSON representation
CRUD Web application with Laravel Livewire and Filament.
- Host: GitHub
- URL: https://github.com/kyle-myre/inventory-management-system
- Owner: Kyle-Myre
- License: mit
- Created: 2024-05-10T23:30:31.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-09T10:15:30.000Z (about 2 months ago)
- Last Synced: 2024-12-09T11:27:12.344Z (about 2 months ago)
- Topics: filament, laravel, livewire, php, vite, vue
- Language: PHP
- Homepage:
- Size: 731 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Here is a sample `README.md` file for your app with GitHub-style badges included:
# Inventory Management System
[](https://www.php.net/)
[](https://laravel.com/)
[](https://opensource.org/licenses/MIT)
## Description
This app is a Filament-based admin panel for managing various resources such as **Categories**, **Customers**, **Orders**, **Products**, **Providers**, and **Users**. It is built using **Laravel** and leverages **Filament** for the admin UI. The app allows for easy resource management with pages and widgets tailored for each type of resource.
### Key Features:
- Resource management with Filament admin panel
- CRUD operations for categories, customers, orders, products, providers, and users
- Custom widgets for data visualization
- Built on Laravel 8+ and PHP 7.4+
## Installation
### Requirements:
- PHP 7.4 or higher
- Laravel 8 or higher
- Composer
### Steps:
1. Clone the repository:
```bash
git clone https://github.com/Kyle-Myre/Inventory-Management-System.git
cd {repo-name}
```
2. Install dependencies using Composer:
```bash
composer install
```
3. Set up the environment file:
```bash
cp .env.example .env
```
4. Generate the application key:
```bash
php artisan key:generate
```
5. Run the database migrations:
```bash
php artisan migrate
```
6. Seed the database (optional):
```bash
php artisan db:seed
```
7. Serve the application:
```bash
php artisan serve
```
The app should now be accessible at `http://localhost:8000`.
## Directory Structure
- **`app/`**: Contains the main application logic including models, controllers, resources, policies, and Filament widgets.
- **`Filament/`**: Custom Filament resources and widgets.
- **`Http/`**: Controllers and resources for the app's HTTP layer.
- **`Models/`**: Database models.
- **`Policies/`**: Authorization policies.
- **`Providers/`**: Service providers.
- **`bootstrap/`**: Application bootstrap files.
- **`config/`**: Configuration files.
- **`database/`**: Database migrations, seeders, and factories.
- **`public/`**: Publicly accessible files like CSS, JS, and vendor assets.
- **`resources/`**: Views and frontend assets.
- **`routes/`**: Route definitions for the application.
- **`storage/`**: Application storage including logs, cache, and session data.
- **`tests/`**: Feature and unit tests for the app.
## Testing
To run tests, use PHPUnit:
```bash
php artisan test
```
For unit tests:
```bash
php artisan test --testsuite=Unit
```
For feature tests:
```bash
php artisan test --testsuite=Feature
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
We welcome contributions to this project! Please follow the standard GitHub fork and pull request workflow:
1. Fork the repository
2. Create a new branch (`git checkout -b feature/feature-name`)
3. Commit your changes (`git commit -am 'Add new feature'`)
4. Push to the branch (`git push origin feature/feature-name`)
5. Open a Pull Request
## Acknowledgements
- **Filament**: A powerful admin panel for Laravel.
- **Laravel**: The PHP framework that powers this app.