Standup App

Do you:

• Often forget what you did yesterday during Standup
• Mention on Monday's that you worked on something "yesterday" instead of on "Friday"
• Have no clue what went well or could be improved during a Sprint
• Enjoy using a terminal

Well, then this app's for you!

Using the latest in Dart and cross platform technology, this app can be used to easily log work done during the day, and see what was done during a Sprint in future. During a Sprint things that went well (or not so well) can also be logged in order to actually be able to contribute when Retro comes rolling around

Basic functionality

This section will give a high level overview of some of the most used commands

Adding an entry

Adding an entry for today is simply standup add "Entry here", which then displays all entries on that date, for example:

Viewing the Standup update

standup view or standup v is the main command that can be used to view the required info for standup. Namely entries added for today, and the previous day with entries, for example:

The app also tries to give the previous entry in a way that's natural to say during standup

Editing or deleting an entry

Entries can be altered or deleted by supplying an index, or simply selecting the relevant entry. The date is also defaulted to today, but can be altered with the date flag (-d or --date), for example:

New Sprint

The new command can be used to create a new Sprint, which can later be used for reporting and saving what went well and could be improved.

(Just a note for the video below, stu is just an alias for clear; standup, st is an alias for clear; standup view, and sta is an alias for standup add)

Abbreviated subcommands

Most commands can be abbreviated to the first letter of the command, for example instead of typing standup add "Entry", standup a "Entry" works the same

Getting help

When in doubt, ask for help with either the -h or --help flag, or the help subcommand

Subcommands also support the help flag

Getting started

Environment variables

The Standup App uses 2 environment variables to determine the location of certain files.

• STANDUP_CONFIG_DIR
  • The app will create its data.json file within this directory if it does not exist
  • This directory can be set to a cloud storage provider in order to sync the data file between different machines
• STANDUP_REPORT_DIR
  • When creating a new sprint or when using the standup sprint generate command a markdown file containing all the details of the current sprint will be created in the directory specified by this environment variable

Terminal application

Installing

To install the terminal application simply go to the Actions section on GitHub, select the latest passing workflow and download the relevant executable from the bottom of the page.

Lastly place the executable in a location that's in the system path in order to run the command from anywhere.

Usage

Once the executable is downloaded and the environment variables set, using the app is as simple as adding an entry with standup add "X".

If there isn't a data file when adding a new entry the app will create the data file and start the prompts to setup the first Sprint

Windows application

The Windows application portion of the system is in a POC state at the moment.

Basically entries can be added and the Standup update can be seen.

Future work will happen on this portion of the app as there should be a complete feature match between the terminal and GUI application.

Contributing

TODO

Project setup

TODO

Special thanks

Special thanks to Entelect and their Tech Accelerator project that supplied the initial time and resources needed to start this project.