🍕 OrderUp HookUp is an web app boasting an intuitive front end to Yelp's API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
public
routes
views
LICENSE.md
README.md
app.js
package.json

README.md

OrderUp HookUp

OrderUp HookUp

OrderUp HookUp is the answer to the question "What's for dinner?"

Can't decide what you're in the mood for? Just put in your location and see what shows up!

See it live here!

Table of Contents

  1. Getting Started
  2. Deployment
  3. Built With
  4. Contributing
  5. Authors
  6. License

Introduction

OrderUp HookUp is a stripped down front end for Yelp's API, with mobile-first design principles at the forefront. OrderUp HookUp is meant to be a general-purpose food finder, giving you a map, phone number, photo, and category for nearby restaurants. The simple, intuitive design makes it easy to quickly see what's nearby and decide on what to eat.

Getting Started

OrderUp HookUp uses Node and Express on the backed, and Angular on the front end.

Prerequisites

Tech

To build OrderUp HookUp, you will need Node and either NPM or Yarn installed. You can download Node here. This will install NPM as well.

You are welcome to use Yarn instead of NPM if you prefer.

Installing

First, clone the project to a local directory.

   git clone https://github.com/regexpressyourself/OrderUp-HookUp.git && cd OrderUp-HookUp

Next, install the dependencies using NPM or Yarn.

Using NPM

   npm install

Using Yarn

   yarn install

API Access

To run OrderUp HookUp, you will need access to Yelp's Fusion API. You can start that process here.

Once you have an id and a secret, you will need to generate a token. This is done with the following command (replacing YOUR_ID and YOUR_SECRET with your Yelp access id and secret, respectively):

curl    -d grant_type=client_credentials  \
        -d client_id=YOUR_YELP_ID         \
        -d client_secret=YOUR_YELP_SECRET \
        'https://api.yelp.com/oauth2/token'

The access_token that is returned still needs to be made available to OrderUp HookUp, however. This is done using the dotenv library.

The token should be declared in a file named .env located in the project root. The .env file should take the following form:

   YELPTOKEN=YOUR_ACCESS_TOKEN

With that completed, you are ready to build the app!

Back to top

Deployment

To deploy OrderUp HookUp, you simply need to run the start script declared in package.json. This will run the ./bin/www file with Node and serve the app locally.

Using NPM

   npm run start

Using Yarn

   yarn run start

That's it! Your development server is running at http://localhost:3000

Back to top

Built With

  • Angular v. 1 - The front end framework that powers the site
  • Node - The backend server
  • Express - Handles all routing in the server
  • EJS - The templating language used to go from Angular data to HTML

Back to top

Contributing

I'm always happy to receive pull requests, questions/issues regarding code, and feature requests on all my projects. Please feel free to open an issue or submit a pull request.

Back to top

Authors

Back to top

License

OrderUp HookUp is licensed under the MIT License - see the LICENSE.md file for details.

Back to top