[![Build Status] (https://travis-ci.org/BaltimorePublicArtCommons/baltimore_public_art_commons.svg?branch=master)]
(https://travis-ci.org/BaltimorePublicArtCommons/baltimore_public_art_commons)
[
Baltimore Public Art Commons is an open source platform to collect and distribute information about public art and monuments throughout Charm City.
The project is built using Ruby on Rails. The following instructions assume your system is configured to run Ruby, Rails, and its dependencies.
- Clone the project
`git clone [email protected]:BaltimorePublicArtCommons/baltimore_public_art_commons.git`
- Navigate to the project directory
`cd baltimore_public_art_commons`
- Install gems
bundle install
*You will need to use the same version of Ruby as the project. The project's Ruby version is defined in the `.ruby-version` file.*
*The install will fail if you don't have Postgres installed and running.*
- Copy database config
`cp config/database.yml-example config/database.yml`
and update the file with your database credentials.
- Setup databases
```
rake db:setup
```
This will create an admin user with email "[email protected]" and password "password".
- Set the application's secret_key_base
From the command line, run `rake secret`. Then, copy the string output and set it as an environment variable called `bpac_secret_key_base`.
- Start the app!
`rails s`
-
We use MailCatcher for checking any mailers you build.
In your console:
gem install mailcatcherThen, when you send an email, you can check it by going to http://localhost:1080/
To be able to re-generate erd.pdf (the Entity-Relationship Diagram), you'll need to have GraphViz 2.2 or higher installed.
On Linux:
sudo apt-get install graphviz
On OS X:
brew install graphviz
Then,
rake erd
Contact the project organziers if you'd like to contribute to the project.