Skip to content

ItsSimonDavis/thyme

Repository files navigation

Thyme ⏱️

A Windows desktop application for time recording and tracking. Built with TypeScript, React, and Electron.

Features

  • ⏱️ Simple Time Tracking: Start and stop timers with a single click
  • 📁 Predefined Categories: GitHub Issues, Standup, Lunch, Retro, Meetings, and Other
  • 🔧 GitHub Integration: Link time entries to specific GitHub issues (e.g., owner/repo#123)
  • 📊 Daily & Total Summary: View your time tracked today and overall
  • 💾 Local Data Storage: All data is stored locally on your machine
  • 🎨 Modern UI: Dark theme with GitHub-inspired design

Installation

Prerequisites

  • Node.js (v20 or higher)
  • npm (v10 or higher)

Development

  1. Clone the repository:
git clone https://github.com/ItsSimonDavis/thyme.git
cd thyme
  1. Install dependencies:
npm install
  1. Build the Electron main process:
npm run build:main
  1. Start the development server:
npm run dev:renderer
  1. In a separate terminal, start the Electron app:
npm start

Building for Windows

To create a Windows installer:

npm run build
npm run package

The installer will be created in the release directory.

Usage

  1. Select a Category: Choose from GitHub Issue, Standup, Lunch, Retro, Meeting, or Other
  2. Enter Description: Describe what you're working on
  3. Add GitHub Issue (optional): If working on a GitHub issue, enter it in the format owner/repo#123
  4. Start Timer: Click "Start Timer" to begin tracking
  5. Stop Timer: When done, click "Stop Timer" to save the entry

All time entries are automatically saved and will appear in the right panel with:

  • Category and description
  • GitHub issue (if provided)
  • Start time and duration
  • Delete option

Data Storage

Time entries are stored locally in your user data directory:

  • Windows: %APPDATA%\thyme\timeEntries.json

Technology Stack

  • Electron: Desktop application framework
  • React: UI library
  • TypeScript: Type-safe JavaScript
  • Vite: Build tool and dev server

License

MIT License - see LICENSE file for details

About

Companion app to speed up time recording.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors