Skip to content

Latest commit

 

History

History
127 lines (80 loc) · 6.98 KB

README.md

File metadata and controls

127 lines (80 loc) · 6.98 KB
Raw

TrailsyServer

Trailsyserver is one of the components, along with Trailsy, of To The Trails, a web application for storing and displaying hiking/biking/equestrian trail data.

To The Trails was developed by 2013 Code for America Fellows working with park and trail organizations in Summit County, Ohio. The application is lightly customized for use in Summit County, but could be repurposed with minimal effort.

The Trailsyserver component includes:

  • a REST-style interface to trail data for consumption by Trailsy (and possibly others).
  • an interface for organizations that maintain trail data to upload and maintain their trail data in the Trailsy database, as well as provide status updates, closure updates, photos, and institutional information for invidivual trails.
  • data structure and API informed by trail standards draft.

Special Note: The Trailsy repository is currently a submodule of this Trailsyserver repository, so if you clone this repository, you can use git submodule init then git submodule update to create a copy of Trailsy in the 'public' directory of Trailsyserver. This setup reduces from two to one the number of Heroku app instances required to run a full instance of To The Trails.

Requirements

  • Ruby 1.9.3 or newer. (All testing so far has been with Ruby 2.0.0)
  • An instance of Postgres with the PostGIS extension installed (can be local or remote--the current production version uses Heroku PostGIS hosting)
  • An Amazon S3 bucket for photo storage. (Not needed for development environment, which stores photos in the local filesystem. See "Local setup" below.)

The Trailsy repo is included in this app's "/public" directory as a git submodule. This allows for a single Heroku instance to run both the front-end and back-end code, while keeping the repositories separate. In development, it's recommended to check out the repositories separately, as updating submodule code can be challenging.

Sample working resource requests

Setup notes

Heroku setup

(For quick step-by-step instructions for creating a new deploy of To The Trails/Trailsy, try the new deploy instructions on the Trailsy repository wiki.)

To set up an instance on Heroku, you need a instance of PostGIS available. The production To The Trails application uses Heroku's PostGIS service.

An Amazon Web Services account is also required for photo storage in Amazon S3. The application uses Paperclip to manage photo attachments, so it could be converted to use any other Paperclip-supported storage backend.

To install on Heroku, you'll need to set the following app config vars:

  • BUILDPACK_URL: https://github.com/ddollar/heroku-buildpack-multi.git
  • GDAL_BINDIR: /app/vendor/gdal/1.10.0/bin
  • DATABASE_URL: postgis://[db_username]:[db_password]@[host]:[port]/[db_name]
  • TRAILSY_AWS_BUCKET: [your AWS S3 bucket name]
  • TRAILSY_AWS_ACCESS_KEY_ID: [your AWS access key id]
  • TRAILSY_AWS_ACCESS_SECRET_ACCESS_KEY: [your AWS access key]

To add these to your Heroku app (Heroku Toolbelt required):

heroku config:add BUILDPACK_URL=https://github.com/ddollar/heroku-buildpack-multi.git
heroku config:add GDAL_BINDIR=/app/vendor/gdal/1.10.0/bin
heroku config:add DATABASE_URL=[your database URL]
heroku config:add TRAILSY_AWS_BUCKET=[bucket] 
heroku config:add TRAILSY_AWS_ACCESS_KEY_ID=[id] 
heroky config:add TRAILSY_AWS_ACCESS_SECRET_ACCESS_KEY=[key]

To initialize the database and set up the initial users:

heroku run rake db:create && db:migrate && db:seed

To populate the database with sample trails, trailheads, and segments from Cuyahoga Valley National Park and Metro Parks, Serving Summit County:

heroku run rake load:all

Local setup

You need the GDAL/OGR package installed locally.

Database environment variables required

There are two "development" Rails environments available:

  • "development" uses a local instance of PostGIS, using the 'pg' gem adapter defaults, and local file storage for photos. You'll need to change the "development" portion of config/database.yml to point to your database.

  • "development-aws" uses a remote instance of PostGIS, and S3 for photos, based on the environmental variables below

    • TRAILSY_DB_DEV_USER=[name of database user]
    • TRAILSY_DB_DEV_HOST=[database host]
    • TRAILSY_DB_DEV_PASSWD=[database password]
    • TRAILSY_DB_DEV_DATABASE=[development database name]
    • TRAILSY_DEV_AWS_BUCKET=[your AWS S3 bucket name]
    • TRAILSY_DEV_AWS_ACCESS_KEY_ID=[your AWS access key id]
    • TRAILSY_DEV_AWS_SECRET_ACCESS_KEY=[your AWS access key]

  • "production" uses a remote instance of PostGIS, based on the environmental variables below (TODO: this isn't really true at the moment)

    • TRAILSY_DB_USER=[name of database user]
    • TRAILSY_DB_HOST=[database host]
    • TRAILSY_DB_PASSWORD=[database password]
    • TRAILSY_DB_DATABASE=[production database name]
    • TRAILSY_AWS_BUCKET=[your AWS S3 bucket name]
    • TRAILSY_AWS_ACCESS_KEY_ID=[your AWS access key id]
    • TRAILSY_AWS_SECRET_ACCESS_KEY=[your AWS access key]

Other environment variables required

Path to GDAL binaries (for ogr2ogr)

  • GDAL_BINDIR=[path] # depends on install -- if using OS X Homebrew, it's /usr/local/bin

Users to create during rake db:seed

Three users will be set up on DB creation. They should be email addresses.

The first is the admin user. This user can approve new user accounts:

  • DEFAULT_ADMIN_USER

These users will have organization field values of "NPS" and "MPSSC" respectively (more generic user names and organizations should be provide for testing, but for now they're not):

  • TEST_NPS_USER
  • TEST_MPSSC_USER

All of these initial users will share the single password in the following environment variable:

  • DEFAULT_ADMIN_PASSWORD

Then run

rake db:create && db:migrate && db:seed

to initialize the database, and optionally run

rake load:all

to load sample data from Cuyahoga Valley National Park and Metro Parks, Serving Summit County.

To start Trailsyserver, start it with rails server. If you're planning on using it with the Trailsy front-end, change API_HOST in the first lines of trailhead.js to point to your instance of Trailsyserver.