erobin27 / yummi

Yummi

A free webservice for analyzing your restaurant's data!
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Yummi is a data analytics web service designed to parse data from a POS System (Point of Sales) to help restuarant owners and managers better understand their restaurant. Currently we are looking to support data from Toast and Square, the two most popular POS Systems you can find in restaurants currently. This project is the CapStone project for our group at UNCC, our group consists of 6 team members: Elijah Robinson, Rebekah Yermakovich, Alexander Jones, Sakshi Kaondal, Varun Pullakandam, and Sean Dehart

What is special about this project?

• This gives owners a way to draw conclusions from their data which they otherwise could not
• This data is presented dynamically and could eventually work with any POS system
• Yummi is a fullstack application allowing for users to store their progress and info
• Yummi uses OAuth2 so your account and data is as safe as your Google account is

(back to top)

Built With

• Reactjs
• Material-ui
• Redux
• DevExpress
• MongoDB

(back to top)

Getting Started

To get started clone the repo to your local machine and begin installing it's dependencies.

Prerequisites

To run this project you will need to have node downloaded. Open your console where you want to install and follow the installation steps.

Installation

1. Clone the repo

   git clone https://github.com/erobin27/Yummi.git

2. Navigate to the folder with package-lock.json

   cd Yummi

3. Install node dependecies with npm

   npm install

4. run the program a new browser window on local host will appear sh npm start

(back to top)

Usage

This webservice will be used for restaurant owners or managers to look into their data and gain insights on trends in their restaurants. This can be used for saving money, stocking inventory, or even changes to staffing.

(back to top)

Roadmap

• Build out front-end
• OAuth2 Login
• Allow users to upload and store data
• [] Dynamically graph data
• [] Editable raw data on manage page
• [] Sales prediction

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

You are not allowed to use this source code.

(back to top)

Contact

Project Link: https://github.com/erobin27/Yummi

(back to top)

Acknowledgments

Credits

• ReadMe Template

(back to top)