{"info":{"_postman_id":"4893aefd-af81-0592-423c-ed02940e1adf","name":"Store Manager Application","description":"

This is a store manager application that allows the stakeholders of a given store to perform actions such as:

\n
    \n
  1. Sign up to the application
    2. \n
  2. Login to the application
    3. \n
  3. Post a product
    4. \n
  4. Post a Sale
    5. \n
  5. Get all products
    6. \n
  6. Get single product
    7. \n
  7. Get all products
    8. \n
  8. Get all sales
    9. \n
  9. Get single sale
    10. \n
\n

Installation\nTake the following steps:

\n
    \n
  1. Create a virtual enviroment with the command $ virtualenv -p python3 env
    2. \n
  2. Activate the virtual enviroment with the command `$ source env/bin/activate``
    3. \n
  3. Ensure you have installed GIT
    4. \n
  4. Clone the repository i.e $ git clone https://github.com/Arusey/Store-Manager-APP.git
    5. \n
  5. Install requirements $ pip install -r requirements.txt
    6. \n
\n

Running Tests\nAfter completing the following, it is time to run the app

\n

To run the tests use $ pytest -v\nTo run the application use export SECRET_KEY=\"\"\nflask run

\n

Technologies used include:

\n
    \n
  1. Python
    2. \n
  2. Flask
    3. \n
  3. Flask-Restful
    4. \n
  4. Json Web Tokens
    5. \n
  5. Heroku
    6. \n
  6. Travis CI
    7. \n
  7. Coveralls
    8. \n
  8. Code Climate
    9. \n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4790487","collectionId":"4893aefd-af81-0592-423c-ed02940e1adf","publishedId":"RWgwRFeP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-10-23T10:42:10.000Z"},"item":[{"name":"Post Product","id":"31012c42-4080-8b46-4e77-02ad140879c6","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-access-token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImtpYmVAZW1haWwuY29tIiwiZXhwIjoxNTQwMjk3MTQ4fQ.nTLZa77Lrvnw3e88ttNGo97WwzQCe8gKrgu2LPLGWo8"}],"body":{"mode":"raw","raw":"\n{\n \"id\" : 1,\n \"name\": \"mboga\",\n \"category\" : \"Food\",\n \"desc\": \"Good chapo\",\n \"currstock\" : 20,\n \"minstock\" : 10,\n \"price\" : 1000\n \n\t\n}"},"url":"https://storemanagerkevin.herokuapp.com/api/v1/products","description":"

Allows the store manager to post the products to be sold.

\n","urlObject":{"protocol":"https","path":["api","v1","products"],"host":["storemanagerkevin","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"31012c42-4080-8b46-4e77-02ad140879c6"},{"name":"Get all Products","id":"77f37ad8-e9f5-27ff-6e8e-01dc280a9a6b","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://storemanagerkevin.herokuapp.com/api/v1/sales","description":"

Allows the store manager to get all the available products for sale in the store

\n","urlObject":{"protocol":"https","path":["api","v1","sales"],"host":["storemanagerkevin","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"77f37ad8-e9f5-27ff-6e8e-01dc280a9a6b"},{"name":"Get single Product","id":"4154c674-fa60-3156-89a0-954e0bb8afc2","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://storemanagerkevin.herokuapp.com/api/v1/products/1","description":"

Allows the store attendant to get a single product and view its details

\n","urlObject":{"protocol":"https","path":["api","v1","products","1"],"host":["storemanagerkevin","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4154c674-fa60-3156-89a0-954e0bb8afc2"},{"name":"Sign up","id":"526f7814-8f58-9cdb-d6ae-2c6e43754517","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic a2V2aW46a2V2"}],"body":{"mode":"raw","raw":"{\n \"name\": \"brian\",\n \"email\": \"brian@email.com\",\n \"password\" : \"Brian#77\",\n \"role\" : \"attendant\"\n\t\n}"},"url":"https://storemanagerkevin.herokuapp.com/api/v2/auth/adminsignup","description":"

Allows the user to sign up to the application after inserting their details.

\n","urlObject":{"protocol":"https","path":["api","v2","auth","adminsignup"],"host":["storemanagerkevin","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"526f7814-8f58-9cdb-d6ae-2c6e43754517"},{"name":"Login","id":"f2fd480b-41bd-4006-be7a-bccb59f267f1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic a2V2aW46a2V2"}],"body":{"mode":"raw","raw":"{\n\t \"email\": \"kibe@email.com\",\n \"password\" : \"Kibet#2\"\n}"},"url":"https://storemanagerkevin.herokuapp.com/api/v1/auth/login","description":"

Allows user to login and given a token after their details are verified and authenticated

\n","urlObject":{"protocol":"https","path":["api","v1","auth","login"],"host":["storemanagerkevin","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2fd480b-41bd-4006-be7a-bccb59f267f1"},{"name":"Get all Sales","id":"3f1a4cc4-2601-48f9-d247-ff60d418e5a7","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-access-token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImpheUBlbWFpbC5jb20iLCJleHAiOjE1NDAzNjc5Mzd9.J5nOzA4oqHeOwaXxAvXaHhTNklGPoRYRMrTlZsqr9TE"}],"url":"https://storemanagerkevin.herokuapp.com/api/v1/sales","description":"

Allows the store manager/attendant to get all sales

\n","urlObject":{"protocol":"https","path":["api","v1","sales"],"host":["storemanagerkevin","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f1a4cc4-2601-48f9-d247-ff60d418e5a7"},{"name":"Post Sale","id":"8cbec60a-1ed3-1506-8040-ad28fcccf7cc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-access-token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImtldmluQGVtYWlsLmNvbSIsImV4cCI6MTU0MDI5Njc2N30.ifW3KgwxjWGl_pYPIfnpeQW128PhuBRli-3ulFRlCO0"}],"body":{"mode":"raw","raw":"\n{\n\t \"id\" :\t 1\n \n}"},"url":"https://storemanagerkevin.herokuapp.com/api/v1/sales","description":"

Allows the store attendant to post a sale

\n","urlObject":{"protocol":"https","path":["api","v1","sales"],"host":["storemanagerkevin","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8cbec60a-1ed3-1506-8040-ad28fcccf7cc"},{"name":"Get Single Sale","id":"97834b39-025e-cb82-5998-c4b9ffc24099","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-access-token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImtldmluQGVtYWlsLmNvbSIsImV4cCI6MTUzOTc5OTI0NH0.nRwMSTi2tuurGOnUh5LAm_p1BhTJ02v-xu-oEagE_u4"}],"url":"https://storemanagerkevin.herokuapp.com/api/v1/sales/1","description":"

Allows the store manager to get a single specific sale using its ID.

\n","urlObject":{"protocol":"https","path":["api","v1","sales","1"],"host":["storemanagerkevin","herokuapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"97834b39-025e-cb82-5998-c4b9ffc24099"}]}