Skip to content

A web application that helps store owners manage sales and product inventory records by allowing them to CREATE sale orders and products, FETCH all sales and products and RETRIEVE a single sale order and product.

License

Notifications You must be signed in to change notification settings

Chell0/store-manager-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Store-Manager-API

Build Status Maintainability Coverage Status

A web application that helps store owners manage sales and product inventory records by allowing them to CREATE sale orders and products, FETCH all sales and products and RETRIEVE a single sale order and product.

Development SetUp

What you need to run this API.

  1. Python 3.
  2. Virtualenv environment.
  3. Postman.

Installation

How to get your development environment running.

  • Clone the repository.
  • Unzip the files to your preferred location.
  • cd into sore-manager-api then api folder.
  • Install a virtual environment pip install virtualenv venv
  • Install the requirements.txt pip install -r requierments.txt
  • Install Postman.

Running Tests

cd into store-manager-api-->api RUN python run.py.

key: Content-Type value: application/json

To test authentication, add this to the header: Get Token from login endpoint

key: Authorization value: JWT TOKEN

Methods Endpoint Action
GET http://127.0.0.1:5000/v1/sales (get all your sales)
POST http://127.0.0.1:5000/v1/sales (create a sale order)
GET http://127.0.0.1:5000/v1/sales/id (get a single sale order by id)
GET http://127.0.0.1:5000/v1/products (get all your products)
POST http://127.0.0.1:5000/v1/products (create a product)
GET http://127.0.0.1:5000/v1/products/id (get a single product by id)

Meta

Gabriel Machel - Twitter

Contributing

  1. Fork it yourname/yourproject/fork
  2. Create your feature branch git checkout -b feature/fooBar
  3. Commit your changes git commit -m 'Add some fooBar'
  4. Push to the branch git push origin feature/fooBar
  5. Create a new Pull Request

About

A web application that helps store owners manage sales and product inventory records by allowing them to CREATE sale orders and products, FETCH all sales and products and RETRIEVE a single sale order and product.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages