Skip to content

Monitor your and your team's code time from WakaTime.

Notifications You must be signed in to change notification settings

arrieguadev/codetictac

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project logo

CodeTicTac

Status GitHub Issues GitHub Pull Requests License


Monitor your code time and your development team from WakaTime.

📝 Table of Contents

🧐 About

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!

🏁 Getting Started

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.

Prerequisites

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

Installing

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

🔧 Running the tests

Tests are implemented only in server-side (you can help, contributing with frontend tests :) ). To run the tests:

cd codetictac-server
yarn test

Contributing

Contribution Guidelines

Read about our Contribution Guidelines.

✍️ Authors

See also the list of contributors who participated in this project.

About

Monitor your and your team's code time from WakaTime.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published