Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ezejosue/inventorysystemdashboard
Welcome to the Product Inventory API! This API provides comprehensive functionalities for managing a product inventory, including authentication and security features.
https://github.com/ezejosue/inventorysystemdashboard
docker laravel-framework mysql
Last synced: 9 days ago
JSON representation
Welcome to the Product Inventory API! This API provides comprehensive functionalities for managing a product inventory, including authentication and security features.
- Host: GitHub
- URL: https://github.com/ezejosue/inventorysystemdashboard
- Owner: Ezejosue
- Created: 2024-05-27T19:23:38.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-06T21:17:13.000Z (7 months ago)
- Last Synced: 2024-11-07T05:15:00.707Z (about 2 months ago)
- Topics: docker, laravel-framework, mysql
- Language: PHP
- Homepage: https://udb-dashboard.vercel.app/login
- Size: 140 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📦 Product Inventory API
Welcome to the Product Inventory API! This API provides comprehensive functionalities for managing a product inventory, including authentication and security features.
## 🛠️ Technologies Used
- **Laravel**: The PHP framework used for building the API logic.
- **MySQL**: Relational database for storing inventory data.
- **Docker**: Ensures a consistent development environment through containerization.
- **Swagger**: Interactive API documentation available at [Swagger UI](http://191.101.232.231:8080/api/documentation#/).
## ✨ Features
- Full CRUD (Create, Read, Update, Delete) operations for product management.
- User authentication and session handling.
- Integrated security to protect inventory data.
## 🚀 Getting Started
### Prerequisites
Ensure you have the following installed on your system:
- Docker
- Docker Compose
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/Ezejosue/InventorySystemDashboard.git
cd InventorySystemDashboard
```
2. **Copy the `.env.example` file to `.env` and configure environment variables:**
```bash
cp .env.example .env
```
3. **Build and start the Docker containers:**
```bash
docker-compose up --build
```
4. **Run database migrations and seeders:**
```bash
docker-compose exec app php artisan migrate --seed
```
## 📘 Usage
The API provides several endpoints for managing product inventory. Full documentation of the endpoints and their usage is available at [Swagger UI](http://191.101.232.231:8080/api/documentation#/).
### Main Endpoints
- **/api/products**: Product management endpoints.
- `GET /api/products`: List all products.
- `POST /api/products`: Create a new product.
- `GET /api/products/{id}`: Get product details.
- `PUT /api/products/{id}`: Update a product.
- `DELETE /api/products/{id}`: Delete a product.
- **/api/auth**: Authentication endpoints.
- `POST /api/login`: Log in.
- `POST /api/register`: Register a new user.
- `POST /api/logout`: Log out.
## 🔍 Testing
You can test and consume the API at the following URL:
[UDB Dashboard](https://udb-dashboard.vercel.app/login)
## 🤝 Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## 📬 Contact
For any questions or comments, please contact [[email protected]]([email protected]).