Skip to content

Latest commit

 

History

History
285 lines (195 loc) · 10.2 KB

README.md

File metadata and controls

285 lines (195 loc) · 10.2 KB
Raw

Forks Stargazers Issues


Logo

Yummy Tummy

Not sure where to eat? Fret not, Yummy Tummy is here to help you and your best friends find new places to dine!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributors
  5. Acknowledgments

About The Project

Yummy Screen Shot

YummyTummy is a web app that is used to discover new eateries in Singapore. This system is designed as a comprehensive platform for users and to provide them with an accessible way of organizing and viewing events. It also enables Host and Invitees to look for new places to eat. With the use of the Google Maps API, the application also provides users with immediate access to information about the suggested eateries as well as the selected eatery. The Google Maps API is also used to generate said eateries.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Prerequisites

  • yarn 
    yarn install
  • All package versions are found in yarn.lock and package.json

Usage

For more examples, please refer to the Documentation

  1. On the Landing Page, Sign In with Google to start using YummyTummy.

2. You will be greeted with the Dashboard where you can view your Upcoming Events and Previous Events.
3. To create a new event, click "Jio Your Friends".

4. Be sure to fill in all the Event Details before creating the event with your location (with current location or manually entering where you are currently at).

5. Copy the Invite URL and share it with your friends!

6. You may edit the details of the event on that Event Page too.To delete and event, click the Delete button.

7. Sit back, relax and wait for your friends to join the event. 8. Satisfied with who's coming? Click the Search button to find the nearest food places for all!
9. Choose from a list of curated food places for you to meet!

10. Your friends will now see your chosen meeting location on their Dashboard.

(back to top)

Contributors

Acknowledgments

(back to top)