Flavorite

We introduce the most powerful way of food recommendation. Your network!

Table of Contents

1. About The Project
   • Tech Used
   • Folder Structure
2. Getting Started
   • Installation

About The Project

Flavorite helps users discover reliable food and restaurant recommendations from their personal network. We know that recommendations from close friends and family can have a powerful impact on our decision-making, especially when it comes to food. That's why Flavorite is designed to help you find the best dining options based on recommendations from people you trust. With a focus on cultural flavor and preference, Flavorite makes it easy to find meals that are sure to meet your satisfaction.

Tech Used

• React.js
• Typescript
• MaterialUI

Folder Structure

.
├── README.md          # project description
├── client             # OpenAPI generated files containing models and API
├── public             # contains static files
├── src                # source files including components, tests, css files

(back to top)

Getting Started

Installation

1. Get a Google Maps API Key at https://mapsplatform.google.com/
2. Clone the repo

   git clone https://github.com/flavorite/web-app.git
   

3. touch .env.local file and add the API Key as follows:

   REACT_APP_API_KEY=<YOUR API KEY HERE>
   

4. Install NPM packages

   npm install
   

5. Run this script to update Client model from OAS

   npm run generate
   

Available Scripts

In the project directory, you can run:

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

   npm start
   

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

   npm test
   

3. Builds the app for production to the build folder. See the section about deployment for more information.

   npm run build
   

4. 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. Note: this is a one-way operation. Once you eject, you can't go back!

   npm run eject
   

5. Run ESLint

   npm run lint
   

6. Run ESLint --fix

   npm run lint:fix
   

7. Run Prettier

   npm run format
   

8. Run OpenAPI generator to generate/update client models

   npm run generate
   

(back to top)