Skip to content
/ taskr Public

The simplest to install and use agile board (CLI and Web)

License

Notifications You must be signed in to change notification settings

paladium/taskr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

taskr

The simplest to install and use agile board (CLI and Web)

Just run

taskr init

To init the project in the current directory

And then

taskr backlog --task "Add more cool features 😃"

Usage

The first step is to initialise a new project using tarkr. To do so, run in the current directory:

taskr init

This will create a taskr.json file in the current directory. All the future operations need to be run from the directory where this file resides. You can add this file to the versioning to enable tracking of the tasks and work across multiple environments.

In taskr tasks have four different sections:

  1. Backlog
  2. Selected for development
  3. In progress
  4. Done

When adding new tasks they are automatically added to the backlog. When the tasks are moved they follow the pipeline:

Backlog -> Selected for development -> In progress -> Done

To add a new task use

taskr backlog --task "My awesome task"

Optionally you may add --deadline option to track the finishing time for the task.

To list all the tasks run:

taskr tasks

This will output:

 BACKLOG               SELECTED FOR DEVELOPMENT  IN PROGRESS  DONE                     
 ---inspiring_buck---                                          ---blissful_ramanujan--- 
 My awesome task                                              Cool                     
                                                              ---trusting_bassi---     
                                                              Work on projects              

When you want your task to move across the pipeline take the id of the task (---blissful_ramanujan) and run:

taskr mv --task inspiring_buck

This will output:

 BACKLOG  SELECTED FOR DEVELOPMENT  IN PROGRESS  DONE                     
          ---inspiring_buck---                   ---blissful_ramanujan--- 
          My awesome task                        Cool                     
                                                 ---trusting_bassi---     
                                                 Work on projects         

UI

Taskr comes with embedded mini-server and UI for managing the tasks visually. In order to view the UI run:

taskr ui

This will run the ui on the port :8080. Open the browser to view the tasks. You can do the same actions as in CLI.

UI of the taskr

Installing

Download the newest release for your system from the Releases tab in GitHub.

Running the tests

Explain how to run the automated tests for this system (Work on it)

Built With

  • Go - The backend & cli language
  • Gin - The web framework used
  • VueJs - The frontend framework
  • CLI - The cli framework
  • Packr - The tool to embed static assets in go binary

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

  • Ilkin Musayev - Initial work - paladium

See also the list of contributors who participated in this project.

License

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

Acknowledgments