Skip to content

Docker-based time/task/notes environment to be used over the CLI anywhere

License

Notifications You must be signed in to change notification settings

LanHikari22/TTM

Repository files navigation

  ████████╗████████╗███╗░░░███╗
  ╚══██╔══╝╚══██╔══╝████╗░████║
  ░░░██║░░░░░░██║░░░██╔████╔██║
  ░░░██║░░░░░░██║░░░██║╚██╔╝██║
  ░░░██║░░░░░░██║░░░██║░╚═╝░██║
  ░░░╚═╝░░░░░░╚═╝░░░╚═╝░░░░░╚═╝
  

An integrated environment for time and task management over docker

Built with ❤︎ by Mohammed Alzakariya

🤔 Why TTM?

Linux offers many powerful tools for time and task management and note taking. This includes taskwarrior and TUI front ends for it such as vit. It includes tmux and vim which can be extended for quick context switching, searching and recording of data to keep our attention focused.

Unfortunately, setting up the right environment takes a lot of work and is not easily reproducible across systems. TTM Offers a fully integrated solution working out of the box with Docker. It includes customizations to tmux, vim, and taskwarrior to enhance user experience and navigation.

Taskwarrior by default needs a lot of configurations which can also be redundant. TTM configures all of this off the bat and offers a subtasks feature and integration between taskwarrior and a calendar react app running out of the box. It also offers note taking capabilities with vim that can easily track refernce with tasks and the calendar.

So in simple words, use TTM to effectively manage your time over the terminal while leveraging web services to give intuitive analytics and reports. This can be run over a server and accessed from anywhere.

✨ Features

  • Built as a docker container for reproducible builds and very easy installation.

  • Docker image mounts on time and task data outside the container which can be git version controlled

  • Integration of various time and task management linux tools as well as vim and tmux for context switching.

  • Builds on Vit, a user interface for Taskwarrior, a terminal task management database

    • Allows for Subtasks and note integration for each task.
    • Integrates Taskwarrior with Calendar events with Calcure and a React google calendar like webapp
    • Integrates with Timetrap for starting and stopping tasks which gives a report on time spent
    • Creates reporting to see how time is broken down by the task, subtask, time code, and project
    • Uses an algorithm to convert order priority calendar events of known time intervals to have known start times
    • Comes with a preprocessor script for easier and generalizable TaskWarrior configuration
  • Enables custom vim and tmux configuration for quick navigation, search, and note taking

  • Enables custom zsh plugin configuration for quick access to history and sytax highlighting and vim-mode terminal editing

  • Comes with Vim macros for color and syntax highlighting of calcure event csv file which updates the react calendar app very quickly

  • A csv file controls the placement of events in the graphical web interface. It also has vim color syntax that can be toggled with a macro to a given day to distinguish planned (yellow), completed (cyan), and pending events (white/blue).

  • Comes with Vim commands for creating note entries and note logs with standardized date codes

  • Ability to timeblock floating events that shift with time according to rules
  • Treemap and heatmap Visualizations that link the concrete events completed to their tracked task and project structure

💼 Requirements TODO

Docker

🛠️ Installation TODO

Simply install the docker image and run it.

📚 Usage

TODO

🌱 Future

  • Implement syncronization with popular calendar and TODO list apps.
  • Implement a rule-based reminder system for events.
  • Implement more analytics and seamless event refitting for liquid timeboxing.

🎉 Credits

🔫 Contributing

Contributions and ideas are always welcome! Feel free to raise a ticket. This is currently early release and there a lot of features to be added.

🌈 License

This theme is licensed under the MIT license © Mohammed Alzakariya.

About

Docker-based time/task/notes environment to be used over the CLI anywhere

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published