Files
archived-hc-harbor/docs/getting-started/quick-start.md
2025-05-28 17:15:22 -04:00

49 lines
1.5 KiB
Markdown

# Quick Start Guide
Get up and running with Hackatime in just a few minutes!
## Step 1: Create Your Account
Visit [hackatime.hackclub.com](https://hackatime.hackclub.com) and sign up using:
- Your Hack Club Slack account (recommended)
- GitHub account
- Email address
## Step 2: Get Your API Key
1. After signing in, go to your dashboard
2. Click on "Setup Tracking" or visit your settings
3. Copy your unique API key - you'll need this for the next step
## Step 3: Install WakaTime Plugin
Hackatime works with all WakaTime plugins. Choose your editor:
**VS Code**:
1. Open Extensions (Ctrl/Cmd + Shift + X)
2. Search for "WakaTime"
3. Install and restart VS Code
**Other Editors**:
- **IntelliJ/PyCharm**: Settings → Plugins → Install "WakaTime"
- **Vim/Neovim**: Install vim-wakatime plugin
- **Sublime Text**: Install via Package Control
- **Atom**: Install wakatime package
## Step 4: Configure the Plugin
1. The plugin will prompt you for your API key on first use
2. Paste your Hackatime API key from Step 2
3. The plugin will automatically configure itself for Hackatime
## Step 5: Start Coding!
That's it! Just start coding normally and your time will be automatically tracked. Visit your Hackatime dashboard to see your coding stats, language breakdowns, and compare with other Hack Club members on the leaderboard.
## Troubleshooting
If you're having issues, make sure:
- Your API key is correctly configured
- Your editor plugin is the latest version
- Check the Hack Club Slack #hackatime channel for help