Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
This is mySociety's popular map-based reporting platform: easy to install in new countries and regions
Perl HTML CSS JavaScript Perl6 PLpgSQL Other
branch: gh-pages

This branch is even with gh-pages

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
_layouts
_posts
assets
blog
community
customising
install
running
theme @ 173e9d9
updating
.gitignore
.gitmodules
404.html
CNAME
Gruntfile.js
README.md
The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf
_config.yml
atom.xml
bower.json
directory_structure.md
favicon.ico
feeding-back.md
glossary.md
how-it-works.md
index.md
overview.md
package.json
sites.md

README.md

fixmystreet.org

The gh-pages branch is fixmystreet.org, the Jekyll-based static site running on GitHub Pages that is the documentation for setting up / running the FixMyStreet platform.

Installation

In the below you could of course run sudo gem install or npm install -g but I personally never think that's a good idea. You must already have gem and git installed (you probably do).

gem install --no-document --user-install github-pages
# Add ~/.gem/ruby/2.0.0/bin/ or similar to your $PATH
# Check you can run "jekyll"
git clone --recursive -b gh-pages https://github.com/mysociety/fixmystreet fixmystreet-pages
cd fixmystreet-pages

If you only want to edit the text of the site, this is all you need. Run jekyll serve --watch to run a webserver of the static site, and make changes to the text you want.

If you want to edit the CSS or JS, or you'd like live reloading of changes in your web browser, you might as well set up the thing that monitors it all for you. You will need npm already installed.

gem install --no-document --user-install sass
npm install grunt-cli
npm install
node_modules/.bin/grunt

This will start up a watcher that monitors the files and automatically compiles SASS, JavaScript, and runs jekyll build when necessary. It also live reloads your web pages.

Lastly, if you'd like to add more JavaScript libraries than the ones already, you'll additionally need to install bower and use it to fetch the libraries used:

npm install bower
node_modules/.bin/bower install

Then use bower to install a new library and add it to the Gruntfile.js.

Something went wrong with that request. Please try again.