Skip to content

Latest commit

 

History

History
107 lines (84 loc) · 3.54 KB

README.md

File metadata and controls

107 lines (84 loc) · 3.54 KB

VSCode Coding Tracker Extension

This Visual Studio Code extension helps you track and analyze your coding sessions by integrating with Discord and logging coding activity to a MongoDB database. It displays your active coding time, language usage, and various achievements through a dedicated Discord bot.

Bot Invite: https://discord.com/oauth2/authorize?client_id=1305258645906526328

Bot Version: beta@v0.7.8

Extension:

Extension Version: beta@v0.6.0

Website: https://distrack-website.vercel.app

Table of Contents

Features

  • Coding Session Tracking: Automatically tracks coding sessions when you start VSCode.
  • Language-Specific Time Tracking: Records the time spent in each programming language.
  • Discord Integration: Shows a real-time status in Discord, including the file and language.
  • Achievements: Gain achievements for milestones based on your total coding time.
  • Profile Management: View coding stats and achievements through a Discord bot.

Installation

  1. Clone the Repository: 
    git clone https://github.com/JayNightmare/DisTrack-VSCode-Extension
  2. Install Dependencies: 
    cd DisTrack-VSCode-Extension
npm install
  3. Setup MongoDB:
    • Ensure MongoDB is installed and running.
    • Create a database and note the connection URI.

Configuration

  1. MongoDB Setup:
    • Ensure the IP address for your server is whitelisted in MongoDB Atlas or your MongoDB instance.

Usage

  1. Start VSCode:

    • When you start VSCode, the extension will automatically begin a coding session and track your active language and coding time.

  2. Link Discord:

    • Click on the status bar item "Link to Discord" and enter your Discord ID to enable activity tracking and achievements through the Discord bot.

  3. Stop Coding Session:

    • When you close VSCode, the session ends, and your session data is saved to the MongoDB database.

Commands

  • Profile: Displays your coding profile, including total coding time, language stats, and achievements.
  • Leaderboard: View the top users based on total coding time
  • Achievements: Lists the milestones you’ve achieved
  • Compare: Compares your stats against another user's stats
  • Freeze Streak: Freezes your streak
  • Help: Shows all commands and info about the bot
  • Recents: Shows information from recent session
  • Set Bio: Sets the bio for the profile command
  • Bug Reports and Suggestions: Sends your feedback to the developement team so we can improve the extension and bot

Contributing

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature-branch
  3. Commit changes: 
    git commit -m "Add a feature"
  4. Push to the branch: 
    git push origin feature-branch
  5. Open a pull request.

License

This project is licensed under the Creative Commons Legal Code License. See the LICENSE file for more details.