Store Manager is a web application that helps store owners manage sales and product inventory records. This application is meant for use in a single store.
http://store-manager-api-2.herokuapp.com
https://storemanagerapi.docs.apiary.io/#
https://www.pivotaltracker.com/n/projects/2203237
The api is constructed using python flask and flask restful
Testing is done using unittest
Test coverage is done using pytest-cov
Clone the repo to your local machine.
Navigate to the project directory.
Install your virtual environment by doing pip install virtualenv.
Activate the virtual environment on mac by $ source env\bin\activate
Activate the virtual environment on windows by env/scripts/activate
Install the dependencies needed by doing $ pip install -r requirements.txt
Then setup the app in the terminal $ export FLASK_APP=run.py
Run using python run.py
open your localhost
open Postman to test.
Test the endpoints using Postman
Download Postman
Copy the link http://127.0.0.1:5000/ into postman if running on your machine locally.
If using the heroku link, copy the link into postman.
Add endpoints as defined in the documentation
Store attendant can search and add products to buyer’s cart.
Store attendant can see his/her sale records but can’t modify them.
App should show available products, quantity and price.
Store owner can see sales and can filter by attendants.
Store owner can add, modify and delete products.
Store owner can give admin rights to a store attendant.
| Method | URL | DESCRIPTION |
|---|---|---|
| GET /products | http://store-manager-api-2.herokuapp.com/api/v1/products | Fetch all products |
| GET /products/productId | http://store-manager-api-2.herokuapp.com/api/v1/products/<int: productId> | Fetch a single product record |
| GET /sales | http://store-manager-api-2.herokuapp.com/api/v1/sales | Fetch all sale records Get all sale records. |
| GET /sales/saleId | http://store-manager-api-2.herokuapp.com/api/v1/sales/<int: salesId> | Fetch a single sale record |
| POST /products | http://store-manager-api-2.herokuapp.com/api/v1/products | Create a product |
| POST /sales | http://store-manager-api-2.herokuapp.com/api/v1/sales | Create a sale order |