jareddlewis / hungr

A restaurant selection application.

Hungr

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About The Project

Are you tired of being paralyzed by indecision? Does the thought of deciding where to eat make your head spin? There are too many restaurants for the human mind to decide between. Enter Hungr. Hungr automatically sources every restaurant around you in a defined radius, and brings the choices to you.

Once all files are installed and your API key is generated from Google, simple run 'npm start' in your terminal of choice. Almost immediately, you will be transported to a magical world where you indecision will disappear.

Will you eat at Subway tonight? Or maybe Burger King? How about pizza? With Hungr, the world is your oyster.

Built With

• Node
• PostgreSQL
• React

Getting Started

Simply fork our repo, clone it to your machine, run 'npm i' and then 'npm start'.

Prerequisites

• npm
• being hungry

  npm install npm@latest -g

Installation

1. Get a free API Key at https://developers.google.com/maps/documentation/javascript/get-api-key
2. Clone the repo

   git clone https://github.com/hungr-team/hungr.git

3. Install NPM packages

   npm install

4. Enter your API key

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/hungr-team/hungr