Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example_project
game
handlebars
holding_assets
spec/javascripts
test_utils
.codeclimate.yml
.crowdin-get-translations
.csslintrc
.env
.eslintrc
.gitattributes
.gitignore
.travis.yml
CONTRIBUTING.md
COPYRIGHT.txt
Dockerfile
LICENSE.md
MANIFEST.in
README.md
compile_handlebars.sh
convert_svg_to_use_width_or_viewbox.sh
crowdin.yaml
docker-compose.yml
run
setup.cfg
setup.py
test_settings.py
versioneer.py

README.md

Rapid Router (codename: ocargo)

Build Status Coverage Status Code Climate Crowdin

A Code for Life project

To use the app

Go to the official Code For Life website.

To run localy with Docker

To run the app locally

  • Clone the repo: https://github.com/ocadotechnology/rapid-router.git. Fork it first if you want to contribute, and work on a separate branch for your work.

Ubuntu / Linux Mint

  • Install prerequisites

    • sudo apt-get install git
    • sudo apt-get install python-dev python-pip
    • sudo pip install virtualenvwrapper
    • sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev gettext
    • sudo apt-get install ruby2.0
    • sudo gem install sass -v 3.3.4 - tested to work with Ruby >1.9 and <2.3.6
  • Make and activate a virtualenv

    • e.g. the first time, mkvirtualenv -a path/to/rapid-router rapid-router

    • and thereafter workon rapid-router

    • NOTE: If you have trouble running these commands (e.g. Command not found: workon), refer to this article, the top answer should help you resolve them. You may need to run:

      export WORKON_HOME=~/Envs
      source /usr/local/bin/virtualenvwrapper.sh
      

Mac OS

  • Install prerequisites

    • brew install rbenv
    • brew install pyenv
    • brew install pyenv-virtualenv
  • Update .zshrc with the following

    • eval "$(rbenv init -)"
    • eval "$(pyenv init -)"
    • eval "$(pyenv virtualenv-init -)"
  • Close and open terminal

  • Run the following commands

    • rbenv install 2.2.9
    • brew install zlib
    • brew install readline xz
    • xcode-select --install
    • pyenv install 2.7.14

Finall, go to the project root and create .ruby-version and .python-version, containing the versions you installed above.

Running the Portal

  • ./run in your rapid-router directory - This will:

    • install all of the dependencies using pip
    • sync the database
    • collect the static files
    • run the server
  • Once you see Quit the server with CONTROL-C, you can open the portal in your browser at localhost:8000.

  • If you have problems seeing the portal on machines with different locale (e.g. Polish), check the terminal for errors mentioning ValueError: unknown locale: UTF-8. If you see them, you need to have environment variables LANG and LC_ALL both set to en_US.UTF-8.

    • Either export them in your .bashrc or .bash_profile
    • or restart the portal with command LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8 ./run.

Localisation

  • For localisation admins:
    • ./run --with-translation-tools in your rapid-router dir to include the translation/localisation libraries
    • You will need your crowdin api key locally in the CROWDIN_API_KEY environment variable, e.g. export CROWDIN_API_KEY=<key>. This can be obtained from the settings page
  • Set your django_language cookie to lol-us to enable in-context localisation

To contribute

Guidelines Please read the contributing guidelines first, thank you. Found a problem? Please check whether it has already been reported in our issue tracker first! If not, add it. Please make sure that you give us a suitable level of detail about the symptoms and how to reproduce it. Please label it as a "bug".
One word of caution: please do not add any issues related to security. Evil hackers are everywhere nowadays... If you do find a security issue, let us know using our contact form.

Want to suggest a feature? Please check whether it has already been added to our issue tracker first! if not, add it. Please make sure that you give us a suitable level of detail about the feature. Please label it as a "suggestion". Please note that we may not act upon all suggestions, if they are not in line with the direction we want to take the project, or if we don't have the development resources to get it done.

Want to help develop? You can contact us using this contact form and we'll get in touch as soon as possible. To know what's going on, check out the issue tracker. The issues with the 'ready for pickup' label are tasks we think are ready to be picked up. Once you have chosen an issue, make sure you assign it to yourself so others don't also pick it up. Develop it on your fork of the project. Please ensure all files have the license at the top (see another source file for an example). Once you are happy that it works, and have written tests for it, submit a pull request. We'll then look to review the changes. If it looks good, we'll merge it. If we find issues with it, we'll let you know and hopefully we can work with you to improve it and get it re-submitted. If it is a change that we just don't want, we'll reject it.