Progress Tracker

A simple, open-source TODO list and progress tracker for Windows. Built with ❤️ using Tauri and Svelte.

📋 Table of Contents

• Features
• Getting Started
• Installation
• Usage
• Contributing
• Roadmap
• Frequently Asked Questions
• License
• Acknowledgements

🌟 Features

📊 Nested Tasks

Organize your work with hierarchical task structures. Break down complex projects into manageable subtasks.

⚖️ Task Weights

Assign importance to your tasks. Heavier tasks contribute more to your overall progress.

🔢 Weight Interpretation

Weights can be interpreted and rendered as different units, making it easier to understand task importance in various contexts.

🎥 Automatic Video Weights

Create TODO lists based on video durations in your filesystem. (Thanks to ffmpeg)

🎨 Custom Themes

Personalize your experience with custom color schemes.

🚀 Getting Started

System Requirements

• 2 GB RAM
• 100 MB free disk space

📥 Installation

Windows

1. Visit the Releases page on GitHub.
2. Download the latest version of the application.
3. Run the installer and follow the prompts.

Building for source (Windows, Linux and MacOS)

Warning

The application has only been tested on Windows and was designed with Windows in mind. It may or may not work correctly on other systems.

There are currently no official releases for Linux or MacOS. However, if there's sufficient user interest in testing and bug reporting, we may consider creating official releases for these platforms in the future.

1. Install dependencies Check tauri's prerequisites and follow the instructions. You will need to install NodeJS, Rust, and a few other platform-dependent dependencies.

2. Download ffmpeg from the official website

3. Clone the repository:

   git clone https://github.com/h8moss/progress-tracker
   cd progress-tracker

4. Get your current target's triple by running this command:

   rustc -Vv | Select-String "host:" | ForEach-Object {$_.Line.split(" ")[1]}
   

   or on linux/macOS:

   rustc -Vv | grep host | cut -f2 -d' '
   

   Remember this value for next step

5. Move ffprobe from the bin folder in ffmpeg to path/to/progress-tracker/src-tauri/binaries and rename it to: ffprobe-{TARGET TRIPLE FROM PREVIOUS STEP}

6. Install dependencies:

   npm install

7. Build the project:

   npm run tauri build

If you encounter any issues during installation or have suggestions for improving cross-platform support, please open an issue on our GitHub repository.

🖱️ Usage

1. Launch Progress Tracker from your applications menu or desktop shortcut.
2. Here you may start a new tracker or open an existing one
3. To add new tasks right click anywhere within the main task and click "new child" or press the big plus button at the bottom.
4. To create subtasks first right click any existing task and click "make childful", then right click it and click "new child"

🛠️ Customization

Creating Custom Themes

1. Navigate to AppData/Roaming/com.h8m0ss.progress-tracker/themes.
2. Create a new JSON file for each theme.
3. Define the theme properties:

{
  "name": "My Custom Theme",
  "textColor": "#000000",
  "textColorB": "#FFFFFF",
  "backgroundColor": "#F0F0F0",
  "darkenColor": [10, 10, 10],
  "highlightColorA": "#4CAF50",
  "highlightColorB": "#45a049"
}

For more details, check out the default themes.

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/your-feature-name.
3. Make your changes and commit them: git commit -m 'Add some feature'.
4. Push to the branch: git push origin feature/your-feature-name.
5. Submit a pull request.

🗺️ Roadmap

• Custom weight units
• Setting default theme
• Duplicating tasks
• Linux / MacOS build

❓ Frequently Asked Questions

Q: Can I sync my tasks across multiple devices? A: Progress Tracker is, and will always remain, a fully offline application, we will never send your tasks over to a server, that being said, you can use an application like syncthing to keep your files perpetually synced across devices

Q: Is there a mobile version available? A: Absolutely no!!!! This is something that we do not have planned as it would require a full rewrite of the application

Q: How can I report a bug or request a feature? A: Please use our GitHub Issues page to report bugs or suggest new features.

📄 License

This project is licensed under the GNU GPLv3 License - see the LICENSE file for details.

🙏 Acknowledgements

Icons

• Arrow-right icon by ByPeople (Public Domain)
• Settings icon by Vmware (MIT License)
• Edit and Save icon by Konstantin Filatov (CC Attribution License)

Icons sourced from SVG Repo.

Technologies

• Tauri
• Svelte
• FFmpeg

---

Made with ☕ by Daniel Armenta © 2023