search

WorldBank-Transport / open-transit-indicators

An open-source tool to support transport agencies in planning and managing public transit systems
GNU General Public License v3.0
44 stars 21 forks source link

readme

open-transit-indicators

An open-source tool to support transport agencies in planning and managing public transit systems

Build Status

Travis CI Build Status

Selenium Test Status

Installation

Vagrant

If you're using Vagrant, then installation is as simple as cloning the repo and then issuing vagrant up from the root of the repository directory.

To change the default amount of memory allocated to the vagrant machine, set the environment variable OTI_VAGRANT_MEMORY to the preferred size, in MB.

Server installation

If you're installing directly onto a dedicated server, follow these steps after cloning the repo on an ubuntu machine version 12.04:

  1. Run the following commands:

    sudo apt-get update
sudo apt-get -y install git

  2. Clone the project into the directory you want the project

    cd <DIRECTORY TO DOWNLOAD/INSTALL PROJECT>
git clone -b master https://github.com/WorldBank-Transport/open-transit-indicators.git

  3. Edit deployment/provision.sh and change the line saying: PROJECTS_DIR="/projects". The text /projects should be replaced with the absolute path of the location where you've cloned the repository. For example, if your repository folder is located in /home/myusername/open-transit-indicators, the line should become PROJECTS_DIR="/home/myusername". You can use pwd to determine this directory.

  4. Move into the open-transit-indicators directory with the following command:

    cd open-transit-indicators

  5. From the repository folder (project directory), issue the command (you may need to enter your password):

    • For development: sudo ./deployment/provision.sh development
    • For production: sudo ./deployment/provision.sh production

AMI Generation

If you want to generate an Amazon Web Service's (AWS) Amazon Machine Image (AMI) you can use Packer to handle the provisioning.

Use the following instructions to do so:

  1. Create an AWS account if you do not have one already
  2. Get the API keys for a new user or an existing user in your AWS account
  3. Download and install Packer
  4. Navigate to the deployment/packer directory
  5. Copy the open-transit-vars.json.example file and save it as open-transit-vars.json
  6. Edit open-transit-vars.json with the API keys downloaded in step 2
  7. Run the following command to generate a new AMI: packer build -var-file=open-transit-vars.json open-transit-indicators.json PLEASE NOTE: Running this command will cause resources to be created in AWS and will cost money
  8. Once the process finishes installing (could take up to an hour), make note of the AMI ID
  9. Launch the AMI using the AWS EC2 management console and browse to the public DNS hostname provided by Amazon