Skip to content

justinphelps/borderland-dreams

 
 

Repository files navigation

Borderland Dreams

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

Midburn runs it at http://dreams.midburn.org and http://dreams.midburnerot.com.

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 db:seed

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

Creating your first user

User types in the system

The system user types are: anonymous users, normal registered users, guides, admins

You can set yourself as a guide and admin in the /admin panel

Guide and admins see buttons on the dream page and info that normal and guests users dont have access to. Guide and admins can close/open granting and edit dreams

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

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.

Drive integration

Google apps script

We've added the ability to integrate to google drive. on every new dream that is being created - a google apps script create a folder with the dream id, dream name, and give access to the dream owner. it also coppies some needed files to that folder and save the folder info and specific file ids to allow the user to edit them directly on google drive.

It require an google apps script published as API execution and also the following env vars:

  • GOOGLE_APPS_SCRIPT
  • GOOGLE_APPS_NAME
  • GOOGLE_DRIVE_INTEGRATION=true
  • GOOGLE_APPS_SCRIPT_FUNCTION='function-name'
  • GOOGLE_CLIENT_SECRETS=content_of_client_secret.json

Ability to Show/Edit Point of Contact

We've added the ability to show a contact person from art-department for the dream-creator in the dream page. This field is editable by admin/guide users only.

You will need to set the following env var:

  • SHOW_POINT_OF_CONTACT=true

About

A platform for planning and crowdfunding co-created events.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 55.2%
  • HTML 30.7%
  • CSS 8.7%
  • JavaScript 5.4%