Kyan Tech Radar

The Kyan Tech Radar, forked from thoughtworks/build-your-own-radar.

Development Environment

• Docker
• Docker Compose
• Make

Environment Variables

You can find some predefined environment variables in .env.sample.

Setup

Clone the project from https://github.com/kyan/tech-radar.

make build setup

Running Locally

make serve
open http://localhost:8080

Updating packages

The node_modules are downloaded during the docker build, so to make a change to the dependencies you'll need to update the package.json and then rebuild the docker container:

make build update

Update

You should update your local environment whenever code is pulled from the remote.

make build update

Linting

The project uses standard for linting.

make lint

Runs standard with a fix flag to automatically resolve issues where possible.

Testing

The project has jasmine for testing.

make test

Runs the full test suite.

Data

The data is pulled from a Google Sheet.

If you need to work from a different sheet for development purposes, first make a copy of the sheet, then publish to the web, then update your .env file setting the value of SHEET_ID to your Google Sheet ID.