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. This is an implementation of a restful api to power the frontend pages.

These instructions will get you a copy of the project up and running on your local machine for development and testing purpose

• Git
• Postman
• Python 3.6
• PostgreSQL

• Clone this repository. git clone https://github.com/andrewhingah/store_manager_3.git

• To test API locally, set up a virtual environment in the base project folder

  • virtualenv venv

• Create a .env file and add the following variables

  source venv/bin/activate

  export FLASK_APP="run.py"

  export FLASK_ENV="development"

  export SECRET="your_secret_key"

  export APP_SETTINGS="development"

• Source the environment variables: source .env

• Install dependecies pip install -r requirements.txt

• Set up database

  Development database

  $ psql -c 'create database <development_database>;' -U <postgres_username>

  Testing database

  $ psql -c 'create database <testing_database>;' -U <postgres_username>

• Run tests pytest --cov=app

• Test the endpoints on postman.

  • Sign in as the default admin

    url: http://127.0.0.1:5000/api/v2/auth/login

    Headers Content-Type: application/json

    Body

      `{
      	"email":"[email protected]",
      	"password":"A123@admin"
      }`
    

  • Copy the access token generated and add it as an Authorization header in the other requests

  • Post product

    A sample post product API request should look like this:

    Headers: Content-Type: application/json Authorization: Bearer +access_token

    Body

      `{
      	"category": "electronics"
      	"name": "Iphone 6",
      	"quantity": "30",
      	"price": 50500
      }`
    

  • To sign up a new store attendant

    url: http://127.0.0.1:5000/api/v2/auth/signup

    Headers: Content-Type: application/json Authorization: Bearer +access_token

    Body

      `{
      	"name": "Henry John"
      	"email":"[email protected]",
      	"password":"A123#tdg3",
      	"role": "normal"
      }
    

  • Create a sale order

    A sample post sale API request should look like this:

      Headers:
      	`Content-Type: application/json`
      	`Authorization: Bearer +access_token`
    
      Body
    
      	`{
      		"product_id": 1,
      		"quantity": "30"
      	}`
    

• Python 3

• Flask

• Flask-Restful

• Fork it from https://github.com/andrewhingah/store_manager_3/fork

• Create your feature branch git branch somefeature then git checkout somefeature

• Commit your changes git commit "Add some feature"

• Push to the branch git push origin somefeature

• Create a new pull request

Andrew Hinga