Store_Manager_develop

Build Status

Introduction

Store Manager is a web application that helps store owners manage sales and product inventory. This application is meant for use in a single store.

• This application should help store owners avoid selling products that have run out of stock.
• The store owner is also referred to as the admin of the application.

Table of Contents

1. Link to Hosted App
2. Link to Pivotal Tracker
3. Tech Stack Used
4. Application Features
5. How To Use
6. Author
7. License

Link to Hosted App

• API link

Templates

• UI templates are hosted on Github pages visit here

Tech Stack Used

• Node.js
• Express
• Body-parser
• Express-Validator
• Babel
• Eslint
• Airbnb - - style guide

Testing tools

• Mocha - A Javascript test framework.
• Chai - Assertion library.
• nyc - A reporting tool

API Documentation

Api Documentation

Application Features

• Admin can add a product
• Admin can update a product
• Admin can delete a product
• Admin can add a store attendant
• Admin can update a store attendant/give admin privilege
• Admin can delete a store attendant
• Admin/store attendant can get all products
• Admin/store attendant can get a specific product
• Admin/store attendant can search a specific product
• Store attendant can add sale orders
• Store/Admin attendant can add product to a category
• Admin can get all sale order records
• Store attendant can view owned records
• Store Attendant/Admin can view owned single sales records
• Admin can add a category
• Admin can update a category
• Admin can delete a category
• Admin/store attendant can get all categories
• Admin/store attendant can get a specific category
• Admin/store attendant can login
• Store attendant can get personal detail

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/julietezekwe/Store_Manager_develop

# Go into the repository
$ cd store_Manager_develop

# Install dependencies
$ npm install

# Create .env file for environmental variables in your root directory like the .env.example file


# Run the app
$ npm start

API endpoints

##USERS
POST Request -> localhost:8000/api/v1/auth/createUser
POST Request -> localhost:8000/api/v1/auth/login
GET Request -> localhost:8000/api/v1/auth/:userId
GET Request -> localhost:8000/api/v1/auth/users
PUT Request -> localhost:8000/api/v1/auth/:userId
DELETE Request -> localhost:8000/api/v1/auth/:userId

##PRODUCTS
POST Request -> localhost:8000/api/v1/products
GET Request ->  localhost:8000/api/v1/products
GET Request ->  localhost:8000/api/v1/products/:productId
GET Request -<  localhost:8000/api/V1/products/:searchString/search
PUT Request ->  localhost:8000/api/v1/products/:productId
PUT Request ->  localhost:8000/api/v1/products/:productId/category   
DELETE Request ->  localhost:8000/api/v1/products/:productId 

##SALES
POST Request ->  localhost:8000/api/v1/sales   
GET Request ->  localhost:8000/api/v1/sales
GET Request -> localhost:8000/api/v1/sales/:saleId
GET Request -> localhost:8000/api/v1/user/sales

##CATEGORIES
POST Request -> localhost:8000/api/v1/categories
GET Request -> localhost:8000/api/v1/categories
GET Request -> localhost:8000/api/v1/categories/:categoryId
PUT Request -> localhost:8000/api/v1/categories/:categoryId
DELETE Request -> localhost:8000/api/v1/categories/:categoryId

Tests

• To run tests, navigate to the project's root directory
• After installation, run npm run test

Author

Chidimma Juliet Ezekwe

License

ISC

---