Giter VIP home page Giter VIP logo

eat-away's Introduction

Eat-Away

This is an app that suggests places to eat using user inputs such as their favorite foods or any food that they are in the mood for. This app will ask for user inputs and search on google map for places that match those inputs. The goal of this app is to help users quickly search for places to eat while tailoring the search result to the either users' inputs or their account settings.

How to contribute

  • Select an issue that you would like to work on.
  • Assign it to yourself or request someone to assign it to you buy leaving a comment and have @khoinguyen-hub in your comment.
  • Follow #Set up and #How to run the app sections to get you started.
  • Make sure to create a new branch before making any changes.
  • Your commit messages should be descriptive of the changes you have made.
  • You should only push changes that you've made or any additional files that you've added. DO NOT push any files that are generated from running the app such as venv or app.cpython-38.pyc.
  • If you use new dependencies, remember to add them to requirements.txt.
  • Create a pull request after you finish making changes.
  • Be sure to link your pull request to the # of the issue you are working on by either linking the issue or leave #[issue number here] in a comment in your pull request.
  • Wait for review and make any changes if necessary.
  • You can create new issue with a description and ask for approval by @khoinguyen-hub in your description.

Set up

  • Use any IDE that works for you, but I recommend using Visual Studio Code.
  • Make sure to have python 3.8 or higher installed in your system.
  • Clone or fork and clone this repository to your local machine.
  • Create a virtual environment to manage your dependencies for this project. py -3 -m venv venv or python3 -m venv venv then venv\Scripts\activate to activate your virtual environment
  • After activating your environment, install the dependencies: pip install -r requirements.txt

How to run the app

  • First, make sure that all dependencies have installed correctly, especially flask.
  • Go to app.py, then open up a new terminal by going to Termial -> New Terminal or Crtl+Shift+` command in Visual Studio Code.
  • Make sure that you are inside the Eat-Away directory. Use cd Eat-Away command inside the terminal if you are not.
  • Run the website with flask: $env:FLASK_APP = "app.py" $env:FLASK_ENV = "development" flask run
  • Click the link that the website is running on to access the app website. -For more information about flask: https://flask.palletsprojects.com/en/2.0.x/quickstart/#a-minimal-application

eat-away's People

Contributors

khoinguyen-hub avatar

Watchers

James Cloos avatar  avatar

eat-away's Issues

Design a homepage for the app

The homepage should have the following:

  • Tittle
  • Text entry boxes for user's inputs (type of food, price range, and allergies). Type of food could be multiple types.

Flask connector

Create flask routes displaying information on the home page. There should be a home page route, a result route, a login and user profile route, and a create account route. They don't have to be functional for now.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.