Local Development

Local Development

Setup

Note: until the containers in the 'containers' repository are in a public docker registry, you'll need to build them locally. The 'containers' repository needs to be cloned in the same directory as the 'code' repository.

Dependencies

• docker
• bash

Steps

1. Clone 'code' repository

git clone git@github.com:timetabio/code.git

2. Clone 'containers' repository

git clone git@github.com:timetabio/containers.git

3. First start

cd code
./scripts/rake.sh # Builds autoloaders, css, js...
./scripts/dev.sh --bootstrap # Builds and starts containers

Tools

./scripts/dev.sh

This script manages the docker containers and helps with elasticsearch and postgres.

To get a full list of all commands run ./scripts/dev.sh --help

dev.sh supports the loading of an rc-file named .devrc located in the repository root.

Currently .devrc only supports setting the amount of worker instances:

#!/bin/sh

WORKER_INSTANCES=12

./scripts/rake.sh

This script executes rake inside our build container.

The most important commands are in a nutshell:

• ./scripts/rake.sh - Builds the whole project
• ./scripts/rake.sh clean - Cleans all built files
• ./scripts/rake.sh <lowercase folder> - Only builds a sub-part of the project (e.g. styles, frontend, ...)