Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 4 KB

README.md

File metadata and controls

107 lines (80 loc) · 4 KB
Raw

Midburnerot Dreams

This is a platform to plan co-created events. It was originally created for Urban Burn Stockholm in 2016 and was then used for The Borderland in 2016 and For Midburnerot 2016. It's being continuously and sporadically developed by a rag-tag team and will probably always be in beta. This version was the adoption of the Midburnerot - Israeli regional winter event. You can see it in action here: http://dreams.midburnerot.com and the original system here: http://dreams.theborderland.se/

To get started

  • Install ruby 2.3.1 (or any ruby will probably work).
  • Install postgres - brew install postgresql
  • Install imagemagick - brew install imagemagick
    gem install bundler # if needed
    bundle install
    bundle exec rake db:migrate

To get all the deps and the database set up properly. To start the server:

bundle exec rails s

Now rails will listen at localhost:3000 for your requests.

Go to dreams/new to create a new dream and to /dreams to see a list of camps.

There are tests

Run them with:

bundle exec rspec spec

Database

Currently sqlite is used as the local database. We will stick to this in development but set up Postgres in production. Install sqlite with your favourite package manager and you should be up and running right away.

Mail

In development mode mailcatcher is configured to catch emails locally for easier testing.

Active Admin

Users and creations can be administrated with Active Admin. After install, run:

bundle exec rake db:migrate
bundle exec rake db:seed

Then naviagte to http://localhost:3000/admin and use admin@example.com and password

Creating your first user

Ticket ID Import

Ticket ids are imported from a two column csv file of IDs which can be set to any url using IMPORT_CSV_URL env variable Rake task is in lib/tasks/import.rake and is run with "bundle exec rake import"

Ticket verifier through TixWise

We've added an optional verification through tixwise - you need to aquire an API from them and then set TICKETS_EVENT_URL ENV variable to a url such as:

https://www.tixwise.co.il/he/api.xml?USER=useremail@gmail.com&PASS=userpass&TOKEN=api_token&VERSION=1.0&ACTION=event_listPurchases&id=event_id

Make sure you change the username, password, token and event id

Production

Schema changes

After any schema changes make sure you run heroku run rake db:migrate --app=YOUR_APP Then you might need to restart the instance with heroku run restart --app=YOUR_APP

Email

To get the mailing system working on Heroku -

  • Add Sendgrid as a Resource (this will automatically set SENDGRID_USERNAME & SENDGRID_PASSWORD)
  • Update the email from using: heroku config:set EMAIL_FROM=galbra@gmail.com

Image upload

To set up the image upload make sure to create the S3 user and set the following heroku env variables

  • S3_BUCKET_NAME
  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY

From our experience, if the s3 bucket didn't exist - it was automatically created on first time upload in case your user have write access to s3.

Deploy

When you commit to master there is an auto commit to staging http://stg-dreams.burnerot.com/ To deploy to production - open heroku dashboard navgiate to project and click on "Promote to production"

Events

Each year we have new dreams. We need to update each year by setting the default_event parameter in the application.rb file and also to create a migration file similar to set_event_default_to_2018 and run it

If you just integrated the events be sure to run rails console OR heroku run rails console --app=YOUR_APP Then set all events to your event - for example for midburnerot2016 we call Camp.all.each do |camp| camp.update(event_id:'midburnerot2016') end