Skip to content

ebenezerdon/Store-Manager

Repository files navigation

Store Manager

Build Status Coverage Status

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.

Github Pages

Index | User Dashboard | Admin Dashboard

Server side hosted on Heroku

https://newstoremanager.herokuapp.com/

Getting Started

Prerequisites to use this api

  1. Postman
  2. Any web browser

Prerequisites to get this api running on your local system

  1. Node js/express
  2. Any text editor
  3. Git

Installation

  1. Clone this repository into your local machine:
e.g git clone https://github.com/ebenezerdon/Store-Manager
  1. Install dependencies
- npm install.
  1. Start the application by running the start script.
  • npm start
  1. Install postman to test all endpoints on port 5001.

Test

run test using 'npm test'.

Features

Required Features

  • 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.

Current Features

  • Store attendant can add product to buyer's cart.
  • Store attendant can search for products by id.
  • Store attendant/admin can see available products.
  • Store owner can see sales and can get sale record by id.

API End Points Test Using Postman

HTTP VERBENDPOINTFUNCTIONALITY
POST /api/v1/login/ User login
POST /api/v1/sales Create a sale record (Only store attendant)
POST /api/v1/users Create a user (Only admin)
GET /api/v1/sales Get all sale records (Only admin)
GET /api/v1/sales/:id Get a sale record by id (Onlyadmin)
GET /api/v1/products Gets all products
GET /api/v1/products/:id Gets a product by id
GET /api/v1/users Gets all users
GET /api/v1/users/:id/ Gets a user by id

Author

  • Ebenezer Don

License

ISC

Acknowledgement

  • Andela

About

Store Manager is a web application that helps store owners manage sales and product inventory records.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published