Skip to content
This repository has been archived by the owner on Jan 14, 2020. It is now read-only.

Latest commit

 

History

History
39 lines (23 loc) · 1.23 KB

README.md

File metadata and controls

39 lines (23 loc) · 1.23 KB

The Pirates Inn Startups API

A simple API wrapper for Angellist. Fetches all the Angellist information about city (location tag within Angellist) and caches it for a day.

Install

Clone this repository

git clone https://github.com/d27y/thepiratesinn-startups-api
cd thepiratesinn-startups-api

Install the necessary npm modules.

npm install

Dependencies

Redis and MongoDB are required to run the API.

Environment

You need to configure your environment to contain the following variables.

  • SESSION_SECRET (random string to salt the session)
  • ANGELLIST_CLIENT_ID (angellist api auth)
  • ANGELLIST_CLIENT_SECRET (angellist api auth)
  • BASE_URI (url for the api)
  • MONGOHQ_URL (uses localhost if not specified)
  • REDISCLOUD_URL (uses localhost if not specified)

Development

Use foreman to run the application locally. You need to set up some environment variables. Create an .env file in this folder and add all the necessary environment variables.

foreman start web

Deployment

It is easy to deploy this api on Heroku or Dokku. Just add the Redis and MongoDB Addons to your app and configure the Heroku environment. Push your code and install the webapp.