Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abrahamuchos/inventory-api
API inventory system developed in Laravel under the TDD methodology.
https://github.com/abrahamuchos/inventory-api
Last synced: 6 days ago
JSON representation
API inventory system developed in Laravel under the TDD methodology.
- Host: GitHub
- URL: https://github.com/abrahamuchos/inventory-api
- Owner: abrahamuchos
- Created: 2024-07-25T15:08:38.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-19T20:01:53.000Z (about 1 month ago)
- Last Synced: 2024-12-19T21:18:05.594Z (about 1 month ago)
- Language: PHP
- Size: 256 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Inventory API
This is an experimental API to manage inventory and stock. All this by managing your users (they must log in).
Rest API for managing items, repurchase, users and stock.
## ✅ Features
- Add item
- Update item
- Get items by filters
- Get item (by sku)
- Get stock and reorder status
- Add stock
- Reduce stock
- Register user
- Login user
## ⚙️ Tech Stack
- Laravel 11.9
- SqLite
- Pest 2.0
## 💾 Installation
Install and run
1. Clone and move to folder
```bash
$ git clone [email protected]:abrahamuchos/inventory-api.git
$ cd inventory-api
```
2. Install dependecies
```bash
$ composer install
```
3. Create a copy of the `.env.example` file and rename it to `.env`. Next, configure the necessary environment variables.
4. Generate an application key by running `php artisan key:generate`.
5. Run `php artisan migrate` to create the database tables.
6. Run `php artisandb:seed` to create dummy data and admin user.
7. Run `php artisan serve` to start the Laravel development server.
## 🧪 Tests
To run all the tests
```bash
$ php artisan test
```
To run a specific test
```bash
$ php artisan test --filter test_name_example
```
## 📄 Docs
[Invoice API Collection - Postman](https://documenter.getpostman.com/view/6168326/2sAYJ3DLtQ)
[Invoice API Collection - Postman](https://www.postman.com/abrahamuchos/workspace/public-projects/collection/6168326-0da64ad0-4488-42d8-bd8a-6b72b4e5023c?action=share&creator=6168326)
You can find a .json with the endpoints in `/docs/Inventory API.postman_collection.json`
## 🧑💻 Authors
- [@abrahamuchos](https://github.com/abrahamuchos)
- [Contact mail](mailto:[email protected])
## 📄 License
[MIT](https://choosealicense.com/licenses/mit/)