x-sushant-x / ProgFlow-Coding-Monitoring-System

ProgFlow is an open-source self-hosted software to keep track of your coding time directly from VS Code.

ProgFlow - Coding Monitoring System

ProgFlow is an open-source self-hosted software to keep track of your coding time directly from VS Code. This source code consist of backend server, frontend web application and database schema.

Written In

How To Setup?

To setup ProgFlow we have to get 4 things running. These four things are Database, Golang Server, Web Frontend and VS Code Extension. Let's setup them one by one.

Database Schema

Find db-schema.sql file under db folder and import it into your PostgreSQL Database.

Server

1. Install Golang in your computer.
2. Go to server/db/connect.go and change your database details there.
3. Important you can use environment variables to store this sensitive data. To make things simple I haven't. But it's highly recommended.
4. Run make run command inside /server folder.
5. Your backend server is now setup and running.

Frontend

1. Go inside web/frontend/src/main.tsx and add Auth0 Domain and ClientID there.
2. Simply run command npm run dev.
3. Now go to localhost:5173 and Sign Up.
4. Your will then be redirected to Home Page. Now go to postgres database and copy your API Key from users table.

Extension

1. It's source code is present in progflow-vscode-extension and can build a installer using this documentation.
2. You will get vsix that can be installed directly in VS Code.
3. After installing this extension press CTRL + SHIFT + P and search for Set API Key and paste your API Key there.
4. Your extension is now connected with server and you can see your coding activity on localhost:5173

Final Words

If you face any issue while setting up ProgFlow please open an issue. I'll reply as soon as possible.