https://github.com/marvinkweyu/stock-trader
An API for the inventory management of SME. A multiple-user type project mimic of a point of sale
https://github.com/marvinkweyu/stock-trader
point-of-sale retail-management
Last synced: about 2 months ago
JSON representation
An API for the inventory management of SME. A multiple-user type project mimic of a point of sale
- Host: GitHub
- URL: https://github.com/marvinkweyu/stock-trader
- Owner: MarvinKweyu
- License: gpl-3.0
- Created: 2022-01-23T06:57:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T08:41:34.000Z (over 2 years ago)
- Last Synced: 2025-01-29T15:50:33.471Z (4 months ago)
- Topics: point-of-sale, retail-management
- Language: JavaScript
- Homepage:
- Size: 4.34 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stock Trader
[](https://github.com/MarvinKweyu/stock-trader)
> An API for the inventory management of SME. A multiple-user type project mimic of a point of sale.
This project handles inventory between an SME and a warehouse. It boasts of having different user type access and automatic restocking of items at a pre-defined level from the stall.
## Local setup
Clone the application, install requirements and run the local server
```bash
pip install -r requirements.txt
python manage.py runserver
```
To access the api:
`127.0.0.1:8000/api/v1/`
For documentation:
`127.0.0.1:8000/api/v1/docs`
### Current users:
**Retailer**
```
username: retailer
email: [email protected]
password: retailer
```
**Warehouse attendant**
```
username: attendant2
email: [email protected]
password: attendant2
```
To make a product sale, make a `patch` request to the product endpoint , changing the product amount as needed.
To make a dispatch from the warehouse, make a similar update request to tehe `reorder` endpoint **changing the status of the reorder.**
# Contribution
To contribute to this project, please fork the repository and make a pull request.
```bash
pre-commit install
```
Run against all files
```bash
pre-commit run --all-files
```
## Tests
```bash
pytest
```
## More Documentation
For development using django and articles around software engineering, please visit [TheGreenCodes](https://thegreencodes.com/).