πŸ“Š Crick is a backend for the Watson time-tracker.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 00c8e8d Feb 26, 2018

README.md

crick

CircleCI

Crick is a backend for the Watson time-tracker, built during a "Le lab" session:

Installation

API

Start the Docker environment (Golang and PostgreSQL containers) with the following command lines:

$ cd api/
$ make dev

Be sure to apply all the migrations:

$ make migrate-up

Get the API logs:

$ make logs

Get help:

$ make [help]

Stop and remove the Docker environment:

$ make down

Load Watson's frames to your local server (python 3.4+ is required):

$ CRICK_API_TOKEN='mytoken' python3 api/scripts/watson_push.py (-h)

About

The API documentation can be found in the apiary.apib file or online at: http://docs.crickapi.apiary.io/. This HTTP API is written in Go and serves two purposes: providing a endpoint for Watson synchronization and allowing the web app to access data.

Web app

$ cd web/
$ yarn install
$ make dev

Browse: http://crick.dev:3000/.

About

The Web application is a create-react-app client side application. Authentication with the HTTP API relies on Auth0.

Contributing

Please, see the CONTRIBUTING file.

Running the test suite

$ cd api/ && make test
$ cd web/ && yarn test -- --watch=false

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See CODE_OF_CONDUCT file.

License

Crick is released under the MIT License. See the bundled LICENSE file for details.