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!
Table of Contents
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.
OrderUp HookUp uses Node and Express on the backed, and Angular on the front end.
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.
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.
Once you have an id and a secret, you will need to generate a token. This is done with the following command (replacing
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:
With that completed, you are ready to build the app!
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.
npm run start
yarn run start
That's it! Your development server is running at http://localhost:3000
- 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
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.
- Sam Messina - Sole Developer
OrderUp HookUp is licensed under the MIT License - see the LICENSE.md file for details.