Monitor your code time and your development team from WakaTime.
This project aims to create a client platform for WakaTime. With the data obtained through the API, charts, estimates and more can be generated. This platform will have both a web and a mobile application. Have a good time!
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them.
You will need install node and yarn (or npm but yarn preferred)
You will need have access to a mongodb server
After install prerequisites, follow these steps:
cd codetictac-server
yarn
cd ../codetictac-web
yarn
Now, on codetictac-server, you have to copy and past .env.example to .env and populate with your environment data.
Note that WAKATIME_CLIENT_ID
and WAKATIME_APP_SECRET
must be obtained in https://wakatime.com/apps, creating a wakatime APP, and WAKATIME_REDIRECT_URL
must to be http://localhost:3000/success and tha URL must be added on your app in https://wakatime.com/apps.
After that, to run backend:
cd codetictac-server
yarn dev
and to run web frontend:
cd codetictac-web
yarn start
Tests are implemented only in server-side (you can help, contributing with frontend tests :) ). To run the tests:
cd codetictac-server
yarn test
Read about our Contribution Guidelines.
- @igorclaudino - Idea & Initial work
See also the list of contributors who participated in this project.