Skip to content

Commit 2ab6f99

Browse files
committed
Initial commit
0 parents  commit 2ab6f99

File tree

3 files changed

+65
-0
lines changed

3 files changed

+65
-0
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Rapid Time Tracker
2+
3+
Rapid Time Tracker is an ultra-lightweight time tracker operating on a local text file.
4+
- **Fast**: Intelligent fuzzy search enables rapid entry input.
5+
- **Logical**: Recorded activities are fully hierarchical, with visualizations capturing time-spending patterns at any scale.
6+
- **Privacy first**: Data is stored in a single local text-editor friendly txt file, which can be managed in any way you'd prefer.
7+
8+
---
9+
10+
![main-screenshot](screenshots/main.png)
11+
12+
---
13+
14+
## Table of Contents
15+
- [Getting Started](#getting-started)
16+
- [Download binary](#download-binary)
17+
- [Building the binary yourself](#building-the-binary-yourself)
18+
- [Development build](#development-build)
19+
- [Usage](#usage)
20+
- [Basics](#basics)
21+
22+
---
23+
24+
## Getting Started
25+
26+
Rapid Time Tracker is built with [Electron React Boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate). Windows, macOS, and Linux are all supported.
27+
28+
### Download binary
29+
Grab the latest binary from the [releases page](https://github.com/TommyX12/rapid-time-tracker/releases).
30+
31+
### Building the binary yourself
32+
33+
1. Clone the repository:
34+
```bash
35+
git clone https://github.com/TommyX12/rapid-time-tracker.git
36+
```
37+
2. Enter the directory and install dependencies:
38+
```bash
39+
cd rapid-time-tracker
40+
npm install
41+
```
42+
3. Build the binary:
43+
```bash
44+
npm run package
45+
```
46+
The built binary will be in `./release/build`.
47+
- **Mac**: Go to `./release/build`, and open the `.dmg` file.
48+
- **Windows**: Go to `./release/build`, and open the `.exe` file.
49+
50+
### Development build
51+
52+
To run a live-reload debug build:
53+
54+
```bash
55+
npm start
56+
```
57+
58+
## Usage
59+
60+
### Basics

_config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
theme: jekyll-theme-midnight
2+
title: Rapid Time Tracker
3+
description: An ultra-lightweight time tracker operating on a local text file.
4+
plugins:
5+
- jekyll-sitemap

screenshots/main.png

80.9 KB
Loading

0 commit comments

Comments
 (0)