This repository is for our sPotholes administrative backend, API, and web frontend.
This project expects you to at least have Ruby 2.1+ and Homebrew installed.
After you clone the repo, navigate to spotholes directory and run:
This will walk you through the setup of the tools for the project for Mac OS X and Homebrew. Additional platform setup scripts/updates are welcome.
sPotholes uses the following tools/libraries outside of the gem bundle.
- imagemagick (v6.8.9)
- libwebp (v0.4.2)
- node.js (v0.12) - This includes npm
- bower (v1.3.12) - installed via npm
(sudo) npm install -g bower
sPotholes uses Google Maps Embed API and requires a browser key to function. This can be obtained by following these instructions. You'll need an app and enable Google Maps Embed API for said app. Then use the credentials section of APIs & auth, to create a Public API access key. The browser version.
Manually Setting Up Local Environment
For image manipulation you will need to install imagemagick and libwebp.
You can install imagemagick and libwebp via homebrew:
brew install imagemagick brew install webp
Note: If either package is not available, you may need to update homebrew. brew update
Alternate Install libwebp via macports:
First update macports, then install libwebp:
sudo port selfupdate sudo port install webp
Install node.js and bower
brew install node npm install -g bower
Get web components
Set up the database (from within the sPotholes directory):
rake db:create rake db:migrate
####We recommed using [POW] (http://pow.cx/) for the local server as it is pretty much configuration free.
curl get.pow.cx | sh
cd ~/.pow ln -s /path/to/spotholes
That's it! Your application is now being served at: http://spotholes.dev
- Fork it ( https://github.com/CodeforBirmingham/spotholes/fork )
- Clone your fork
- Add source repo as org (
git remote add org email@example.com:CodeforBirmingham/spotholes.git)
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request