sweet pinballin' brah
API Documentation
Available here: http://pinballmap.com/api/v1/docs
Mac Environment Setup
Below is a summary of the steps that Brian Hanifin undertook to get the site up and running on OS X 10.9. If you would like to contribute, and have any trouble, please ask.
-
Follow the Ruby install instructions at railsapps.github.io/installrubyonrails-mac.html. Make sure you also download ruby-2.5.3.
-
cd /Projects-Path/
-
git clone https://github.com/scottwainstock/pbm.git
(I used the SourceTree app instead.) -
cd /Projects-Path/pbm
-
rvm --default use ruby-2.5.3
-
bundle install
-
selenium install
-
brew update
-
cp config/database.yml.example config/database.yml
to create your database.yml for development -
brew install postgresql
-
initdb /usr/local/var/postgres -E utf8
-
Download Postgres App. (I have mine run at startup on my "Dev" profile.)
-
CREATEDB pbm_dev
-
bundle exec rake db:create ; RAILS_ENV=test bundle exec rake db:create
-
bundle exec rake db:migrate ; RAILS_ENV=test bundle exec rake db:migrate
-
rake doc:app
(I think this generates documentation for the app, which sounds helpful for later.) -
curl get.pow.cx | sh
-
cd ~/.pow
-
ln -s /Projects-Path/pbm
-
open http://pbm.dev
Start server: bundle exec rails s
Run tests: bundle exec rake
If the site loads properly it will be an empty version of pinballmap.com, then ask Scott for a data dump so you can have a full set of data to work with.
Linux Setup
- Fork it. Then:
clone https://github.com/{you}/pbm.git
git remote add upstream git://github.com/scottwainstock/pbm.git
-
Install postgresql and pgadmin3 via package manager.
-
Setup postgres (good luck):
- ubuntu/debian/linux mint: maybe this
- arch/manjaro: this and then this
- Install and setup ruby and rvm:
curl -L https://get.rvm.io | bash -s stable --ruby
rvm install ruby-2.5.3
rvm --default use ruby-2.5.3
gem install bundler
bundle install
cp config/database.yml.example config/database.yml
to create your database.yml for developmentbundle exec rake db:create ; RAILS_ENV=test bundle exec rake db:create
bundle exec rake db:migrate ; RAILS_ENV=test bundle exec rake db:migrate
- Get a database dump from Scott. Then:
pg_restore --verbose --clean --no-acl --no-owner -h localhost -d pbm_dev dump.file
Start server: bundle exec rails s
Run tests: bundle exec rake