Store Manager

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.

Setup

To setup,

1. You can clone the repository using the link here

   $ git clone https://github.com/myrdstom/Store-Manager
   

2. Download and install python 3.6 or higher

3. Install pip here

4. Switch to the directory that you have just cloned and set up a virtual-environment

   $ cd store manager
   $ pip install virtualenv
   $ Linux and MacOS users : virtualenv --python=python3 venv
   $ Windows users: virtualenv venv
   $ Linux and MacOS users: source venv/bin/activate
   $ Windows users: cd venv/bin/activate    
   

   Note if you are using windows activate the environment with venv/scripts/activate

5. Move to the root directory of the project

6. Install all dependencies in the requirements.txt to finalise setting up the environment.

   pip install -r requirements.txt   
   

7. Download and install the postgreSQL database here

8. Create two databases store_manager_pk for the production environment and test_store_manager for the test environment

Build

1. Run the file run.pypython run.py in the root directory and follow the prompts

2. Test all endpoints with POSTMAN

The endpoints:

End Point	Description
GET /api/v1/signup	Register a new user
POST /api/v1/login	Login a new user
GET /api/v1/products	Get all products
POST /api/v1/products	Post a new product
PUT /api/v1/products/int:product_id	Edit a product
DELETE /api/v1/products/int:product_id	Delete a product
GET /api/v1/products/int:product_id	Return a single product
GET /api/v1/sales	Get all sales
POST /api/v1/sales	Post a new sale
GET /api/v1/products/int:sale_id	Return a single sale

Tests

1. pip install nose

2. Run nosetests --with-coverage --cover-package=app to run all tests with coverage

Deployment

The Python application is hosted on Heroku

The application is documented on Swagger

##Built with The project has been built with the following technologies so far:

• HTML
• CSS
• Javascript
• Python/Flask
• postgreSQL
• Swagger

Author

Paul Kayongo