Skip to content

Commit

Permalink
Merge pull request #43 from Easybuoy/chore/165007682/edit-repo-readme
Browse files Browse the repository at this point in the history
#165007682 Edit Repo Readme
  • Loading branch information
Easybuoy committed Mar 31, 2019
2 parents 16b0b71 + 8f71274 commit 48a6960
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 2 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 Ekunola Ezekiel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
67 changes: 65 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,68 @@
[![Build Status](https://travis-ci.org/Easybuoy/storemanager-react.svg?branch=develop)](https://travis-ci.org/Easybuoy/storemanager-react)
[![Coverage Status](https://coveralls.io/repos/github/Easybuoy/storemanager-react/badge.svg)](https://coveralls.io/github/Easybuoy/storemanager-react)
[![Maintainability](https://api.codeclimate.com/v1/badges/497f568b883807b4e900/maintainability)](https://codeclimate.com/github/Easybuoy/storemanager-react/maintainability)
# storemanager-react
React Version Of Store Manager Application
![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)

# Store Manager
A web application that helps store owners manage sales and product inventory records. Store owners/managers can create store attendant accounts who would be in charge of selling of items in the store.

<br>
<img src="client/assets/images/uitemplate.png" />

## Testing & Login Credentials
<pre><code>
App Url: <a href="https://storemanagerreact.herokuapp.com">https://storemanagerreact.herokuapp.com</a>
</code> </pre>
<br>

<ul><li>Admin Login Credentials</li></ul>
<pre><code>
Email: admin@storemanager.net
Password: 123456
</code> </pre>
<br>

<ul><li>Store Attendant Login Credentials</li></ul>
<pre><code>
Email: attendant@storemanager.net
Password: 123456
</code> </pre>
<br>

## Getting Started

<h3>Prerequisites</h3>
You need Nodejs Installed to be able to run this project on your machine.

<h3>Installing<h3>
<ul><li>Clone Repository</li></ul>
<pre><code>git clone https://github.com/Easybuoy/storemanager-react</code> </pre>
<br>
<br>

<ul><li>Change Directory To Store Manager</li></ul>
<pre><code>cd storemanager-react</code></pre>
<br>
<br>

<ul><li>Install Dependencies</li></ul>
<pre><code>npm install</code></pre>
<br>
<br>

<ul><li>Start Application</li></ul>
<pre><code>npm run start</code></pre>
<br>
<br>

<ul><li>Run Test</li></ul>
<pre><code>npm test</code></pre>
<br>
<br>

<ul><li>Run Coverage Report</li></ul>
<pre><code>npm run coveralls</code></pre>
<br>

## License
<h4>This project makes use of the MIT License which can be found <a href="https://github.com/Easybuoy/storemanager-react/blob/develop/LICENSE">here</a></h4>
Binary file added client/assets/images/uitemplate.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 48a6960

Please sign in to comment.