Skip to content

nycmkm/wonka

Repository files navigation

wonka

Run giveaways from the set of attendees checked in for an Eventbrite event

Local Setup

  1. Wonka runs locally using Docker and Docker Compose. Make sure Docker is installed and running.
  2. Create a .env file with the following keys. You can use this documentation to find your Eventbrite keys.
TITO_ACCOUNT_ID=
TITO_API_KEY=
  1. make dev will run database setup/migrations, spin up the necessary containers, and the application will be available at http://localhost:5000
  2. In a rails console, make a user with User.create!(email: <EMAIL>, password: <password>)

Storage for images

In a local environment, uploaded images will be stored on disk. In production, you must configure an AWS S3 Bucket (guide). Set the appropriate AWS environment variables as listed in config/storage.yml.

Accessing a shell

make console will bring up a bash prompt inside the web container. From there you can run rails console to access a console.

Running tests

make test

Running linters

Rubocop and Brakeman are run automatically by GitHub Actions. If you want to run them locally, you can run

make lint

Coverage Status