addae

README

ADDAE - A TUI Project Management Tool

Addae is a terminal-based project management tool designed to help you manage all your projects in one place. It provides a simple and efficient way to track projects, tasks, and development logs without leaving your terminal.

📸 Screenshots

Project List View: See all your projects at a glance.

Task Management: Easily add, edit, and complete tasks.

Log Editor: Write and view development logs with markdown support.

Delete Project Dialog: Confirmation dialog for deleting projects.

✨ Features

• Project Management: Create, update, and delete projects with ease.
• Task Tracking: Add, edit, and complete tasks for each project.
• Development Logs: Keep a log of your development progress with markdown support.
• Vim Keybindings: Navigate the application using familiar Vim keybindings.
• Multiple Views: Switch between a project list, detailed project view, and task/log tabs.
• Status Indicators: Quickly see the status of your projects (e.g., TODO, In Progress, Completed).

🚀 Installation

From a Release

This is the recommended method for most users.

1. Go to the Releases page.
2. Download the appropriate binary for your operating system and architecture (e.g., addae-linux-amd64, addae-darwin-amd64, addae-windows-amd64.exe).
3. (Optional but recommended) Move the binary to a directory in your system's PATH for easy access from anywhere. For example:

   # For Linux/macOS
   mv ./addae-darwin-amd64 /usr/local/bin/addae
   
   # Make it executable
   chmod +x /usr/local/bin/addae
   

4. Run addae from your terminal.

From Source (for developers)

If you have Go installed, you can build addae from the source code.

go install github.com/quamejnr/addae@latest

[!Note] If having difficulty installing with go, you add the specific release version instead of latest

go install github.com/quamejnr/addae@v0.1.3

⌨️ Keybindings

Addae uses Vim-style keybindings for navigation. Here are the most common commands:

Key	Action
↑ / k	Move up
↓ / j	Move down
← / ctrl+h	Previous tab
→ / ctrl+l	Next tab
1	Show details
2	Show tasks
3	Show logs
enter	Select object / switch focus
n	Create object
t	Create task
l	Create log
d	Delete object
u	Update project
e	Edit
space	Toggle done
c	Toggle completed
?	Toggle help
esc / b / ctrl+c	Back

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📜 License

This project is licensed under the MIT License - see the LICENSE.md file for details.