Code Monkey home page Code Monkey logo

store-manager's Introduction

Build Status Coverage Status Maintainability

Store-Manager

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.

Table of Contents

Application features

  • Admin can register new Store Attendant to the application
  • Admin/Store Attendant can login to the application
  • Admin can create a product record
  • Admin/Store Attendant can get all products in the store.
  • Admin/Store Attendant can get details of a single product in the store
  • Admin can update records of a single product in the store.
  • Store Attendant can post a sale record
  • Admin/Sale Creator can get details of a single sale
  • Admin can get all sale records

UI

https://danoseun.github.io/Store-Manager/UI

API Routes

HTTP VERBENDPOINTFUNCTIONALITY
POST api/v1/sales Create Sale Record
GET api/v1/sales/:saleId Get A sale record
GET api/v1/sales Get All sales
POST api/v1/products Create a product record
GET api/v1/products/:productId Get a single product in the store
GET api/v1/products Get all products in the store
PUT api/v1/products/:productId Update details of a product
POST api/v1/auth/signup Create a user
POST api/v1/auth/login Sign in a user

Prereequisites

  • Install Nodejs and PostgreSQL locally

Getting Started

Follow the steps below to get the app running locally:

# Clone the repository
>$ git clone https://github.com/danoseun/Store-Manager.git

# Change directory into it
>$ cd Store-Manager

# Install all dependencies
> npm install

# Start the application in development mode
> npm run start

# Open the application in the browser
> https:localhost:4000/

Running the tests

npm run test

Built with

FrontEnd

HTML- Markup language CSS- Styling

Backend

Nodejs Express

Contributing to the Project

Contributions are welcome and appreciated. To contribute

  • Fork this repository or clone the repository with the command
    $ git clone https://github.com/danoseun/Store-Manager.git
  • Change directory into the folder with the command
    cd Store-Manager
  • Create your feature branch and make your contributions to your local copy of the project
  • Raise a pull Request against the development branch describing what your feature does and how it can be tested

Credits

Oluwaseun Somefun

store-manager's People

Contributors

danoseun avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.