depoulo / Circle-CI-Wall

⚡ Simple framework for easily creating dashboards to display metrics ⚡

First, create personal API tokens for CircleCI and GitHub.

Run on your VM

Using this docker-compose.yml:

metricio:
  container_name: circle-ci-wall-metricio
  image: epages/circle-ci-wall:latest
  links:
    - "redis:redis"
  ports:
    - "8009:3000"
  restart: "always"
  environment:
    REDIS_SERVER_HOST: "redis"
    CIRCLE_CI_TOKEN: $CIRCLE_CI_TOKEN
    GITHUB_USER: $GITHUB_USER
    GITHUB_TOKEN: $GITHUB_TOKEN

redis:
  container_name: circle-ci-wall-redis
  image: redis:latest
  restart: "always"

Just run the following commands:

export CIRCLE_CI_TOKEN=<your-token>
export GITHUB_USER=<your-user-name>
export GITHUB_TOKEN=<your-token>
docker-compose up -d

Local development

1. git clone https://github.com/depoulo/Circle-CI-Wall.git && cd Circle-CI-Wall
2. npm install
3. export CIRCLE_CI_TOKEN=<your-token> (see above)
4. export GITHUB_USER=<your-user-name> (see above)
5. export GITHUB_TOKEN=<your-token> (see above)
6. npm start
7. navigate to http://localhost:3000

Contributing

1. fork project
2. hack around
3. npm run lint
4. npm test
5. push your changes
6. open a pull request

See the Docs for requirements, setup and customisation.

License

Distributed under the MIT license