Skip to content

CloudyPadmal/sysco-pos-react-front-end

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sysco Point of Sales System - React Redux

Codacy Badge Build Status codecov GitHub Release Date Website GitHub repo size in bytes Repo description

This repository contains front end implementation of PoS system using ReactJS with redux fully integrated for state management. Source code is developed using ReactJS with Redux in VSCode IDE. There are three branches maintained in this project.

  • development-redux branch containing source code under development using redux
  • development-pure branch containing source code under development using ReactJS with manual state control
  • deployment hosting branch in Heroku. Pushes to this branch will deploy the content in the hosted website

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Installing

Configuring the project in your own workstation is easy. First, make sure the prerequisites tools and libraries are installed. Clone the project and install dependencies using npm install command. Once all the dependencies are set, go to root folder and run npm start. It will display on which port the application has started and a link to access the web site.

Running the tests

API is fully integrated with unit testing plus component testing and it covers almost 95% of source code. Tests can be run using the following command on the whole project. Codacy is integrated to measure code quality and coverage. Required keys for codacy is in Travis build system and therefore ignore all the warnings generated by codacy in a local build.

$ npm test

Deployment

This site is already hosted in a free Heroku platform using free dynos. There might be slight delays to start up the app due to the use of free dynos. In order to deploy your own version of this app, please follow deployment instructions provided in Heroku. URL for the hosted website is . The backend is developed seperately and it can be found in a GitHub repository: sysco-pos-nodejs-server along with the documentation in swaggerhub

Maintainer