☕️

Getting Started

Prerequisites

• PostgreSQL

Installing and Running

1. Make sure that all prerequisites are installed and running locally.
2. Run rails credentials:edit to add the required credentials.
3. Run bin/setup to install dependencies and prepare the local database.
4. Run rails s to start the Rails server.

Required Credentials

cloudinary:
  cloud_name: YOUR_CLOUDINARY_CLOUD_NAME
  api_key: YOUR_CLOUDINARY_API_KEY
  api_secret: YOUR_CLOUDINARY_API_SECRET

foursquare:
  client_id: YOUR_FOURSQUARE_CLIENT_ID
  client_secret: YOUR_FOURSQUARE_CLIENT_SECRET

twitter:
  consumer_key: YOUR_TWITTER_CONSUMER_KEY
  consumer_secret: YOUR_TWITTER_CONSUMER_SECRET
  bearer_token: YOUR_TWITTER_BEARER_TOKEN

superadmin: YOUR_TWITTER_ACCOUNT_NAME

Running the tests

rspec

Linting

bin/lint

Deployment

Deployment of the master branch to Heroku is done manually after CI passes.

API

Endpoint: https://coffeecoffeecoffee.coffee/api

Documentation is available in /docs.

Admin Instructions

Creating an Event

1. Sign in
2. Visit https://coffeecoffeecoffee.coffee/admin
3. Click "New event"
4. Fill out the form *Note: Times in the admin panel are in UTC. Here's a handy time zone converter: https://www.timeanddate.com/worldclock/converter.html
5. To find the Foursquare Venue ID, find the URL of the venue on Foursquare (e.g. https://foursquare.com/v/blue-bottle-coffee/5c3384fbacc5f5002c89a62c) and copy the Venue ID from the URL (e.g. 5c3384fbacc5f5002c89a62c)
6. Click "Create event"

License

This project is licensed under the GNU GPLv3 License -- see the LICENSE.md file for details.