diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9d974d9 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md index 597eba5..a2fb564 100644 --- a/README.md +++ b/README.md @@ -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. + +
+ + +## Testing & Login Credentials +

+App Url: https://storemanagerreact.herokuapp.com
+ 
+
+ + +

+Email: admin@storemanager.net
+Password: 123456
+ 
+
+ + +

+Email: attendant@storemanager.net
+Password: 123456
+ 
+
+ +## Getting Started + +

Prerequisites

+You need Nodejs Installed to be able to run this project on your machine. + +

Installing

+ +
git clone https://github.com/Easybuoy/storemanager-react 
+
+
+ + +
cd storemanager-react
+
+
+ + +
npm install
+
+
+ + +
npm run start
+
+
+ + +
npm test
+
+
+ + +
npm run coveralls
+
+ +## License +

This project makes use of the MIT License which can be found here

\ No newline at end of file diff --git a/client/assets/images/uitemplate.png b/client/assets/images/uitemplate.png new file mode 100644 index 0000000..d22b74f Binary files /dev/null and b/client/assets/images/uitemplate.png differ