GitXplorerGitXplorer
n

devtime

public
6 stars
1 forks
1 issues

Commits

List of commits on branch main.
Unverified
78d384bdba3fad7fc8f8d8f343fd12af77a4a534

Fix env file for AUTH0 token

nnikochiko committed 3 years ago
Unverified
c6da69b66fca0c2f87ed21b1044150d352f19707

More commands to the makefile

nnikochiko committed 3 years ago
Unverified
a2fe3b0daf252cba6b3e9a6dba2abab3a141dd83

Add Makefile with one-time setup

nnikochiko committed 3 years ago
Verified
2e0b08c6e249e711269ca9a332797036e499a51a

Update README.md

nnikochiko committed 4 years ago
Verified
6ef18cf8d5bb508f3e75db552a72fa3195b6a6c6

Merge branch 'main' of github.com:nikochiko/devtime into main

nnikochiko committed 4 years ago
Verified
ddf1e82ddfe23c61900183d83b87af26b9dd3ad3

Fix pages, many fixes

nnikochiko committed 4 years ago

README

The README file for this repository.

DevTime - Code-time metrics for developers 👨‍💻

🕒 We track time for you while you do the coding. Available at DevTime.Tech

image

How to use?

  1. Sign up for DevTime on https://devtime.tech. It's still a work in progress so you might notice a few bugs and a few incomplete views. Report them, on the issues tracker right here.
  2. Get the DevTime extension for your editor. We have the one for VS-Code available atm - https://marketplace.visualstudio.com/items?itemName=DevTime.devtime
  3. Get your API-key from the activity tab. Now when you open VS-Code, it will prompt you for this API key. Copy/paste the key there and you're good to go!!
  4. Now now you can just focus on writing your code. You can go to the dashboard - https://devtime.tech/dashboard and see your activity. But hey that's not even half of what DevTime means to become, so you keep writing your code, we'll keep adding new fun features. We'll notify you when we do 😄

Development Setup

Techstack

The main server is a Flask app - designed so to keep it small and lightweight. The production database is a PostgreSQL DB on Heroku, although the app is configured to run with SQLite without any additional dependencies (especially useful for development environments).

Cloning the Repo

To get the repository on your local device, install git and run:

git clone https://github.com/nikochiko/devtime.git

[For the server] Get the server running

  1. Make changes in the app/config.py file and edit the Auth0 keys as per your app. Create the app on Auth0. You'll also have to create a GitHub OAuth app, and connect it from the Auth0 connections dashboard.

  2. Navigate to server/ directory in the terminal and install the dependencies.

cd server/

# optional: install and setup virtualenv
python3 -m venv venv/  # this sets up a virtual environment in venv/ directory
source venv/bin/activate  # activate that venv. use `deactivate` to exit it later

python3 -m pip install -r requirements.txt
  1. Copy .env.example to .env. This is where we'll keep top-level configuration. Saves us the hassle of going into editing code every time we change something. This is especially useful to store config variables that are sensitive (api-keys, secrets). For example, on Linux:
cp .env.example .env
  1. Now run the server with Flask
flask run -h 0.0.0.0 -p 8000

Now go to your browser and head to http://localhost:8000 to see the website in action.

Roadmap

The project currently has:

  • Authentication setup with GitHub OAuth via Auth0
  • API-Key functionality
  • Ability to receive heartbeats from editors and store them as coding sessions in the database
  • [x] Better UI/UX
  • [x] Coding charts - hourly, daily, weekly

What we want it to have in the future:

  • [ ] Widgets of these charts for showing on Portfolios
  • [ ] Widget for whether the user is currently coding/idle/offline
  • [ ] Editor plug-ins: