Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
node_modules/
dist/
dist-renderer/
*.log
.DS_Store
51 changes: 20 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Thyme ⏱️

A Windows desktop application for time recording and tracking. Built with TypeScript, React, and Electron.
A simple desktop application for time recording and tracking. Built with Electron following the official tutorial structure.

## Features

Expand All @@ -9,7 +9,6 @@ A Windows desktop application for time recording and tracking. Built with TypeSc
- 🔧 **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

Expand All @@ -18,7 +17,7 @@ A Windows desktop application for time recording and tracking. Built with TypeSc
- Node.js (v20 or higher)
- npm (v10 or higher)

### Development
### Setup

1. Clone the repository:
```bash
Expand All @@ -31,31 +30,24 @@ cd thyme
npm install
```

3. Build the Electron main process:
```bash
npm run build:main
```

4. Start the development server:
```bash
npm run dev:renderer
```

5. In a separate terminal, start the Electron app:
3. Run the app:
```bash
npm start
```

### Building for Windows
That's it! No build step needed - just run it directly.

To create a Windows installer:
## Project Structure

```bash
npm run build
npm run package
```
Following the [Electron "Building your First App" tutorial](https://www.electronjs.org/docs/latest/tutorial/tutorial-first-app):

The installer will be created in the `release` directory.
```
thyme/
├── main.js # Main process (Node.js)
├── preload.js # Preload script
├── index.html # Renderer (HTML + inline JavaScript)
└── package.json # Single dependency: electron
```

## Usage

Expand All @@ -65,23 +57,20 @@ The installer will be created in the `release` directory.
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
All time entries are automatically saved and will appear in the right panel.

## Data Storage

Time entries are stored locally in your user data directory:
Time entries are stored locally in:
- Windows: `%APPDATA%\thyme\timeEntries.json`
- macOS: `~/Library/Application Support/thyme/timeEntries.json`
- Linux: `~/.config/thyme/timeEntries.json`

## Technology Stack

- **Electron**: Desktop application framework
- **React**: UI library
- **TypeScript**: Type-safe JavaScript
- **Vite**: Build tool and dev server
- **Electron**: Desktop application framework (only dependency!)
- **Vanilla JavaScript**: No frameworks, no build step
- **HTML/CSS**: Simple, standard web technologies

## License

Expand Down
6 changes: 0 additions & 6 deletions electron/preload.ts

This file was deleted.

Loading