8000 GitHub - cs0lar/ProGBarZ: Create task lists with associated progress bars.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

cs0lar/ProGBarZ

Repository files navigation

ProGBarZ

Create task lists with associated progress bars.

Getting Started

  1. npm install
  2. Create an .env file (see .env.example) and specify where ProGBarZ should create the database data file (e.g. ~/.progbarz)
  3. npm start

Dependencies

ProGBarZ relies on the following frameworks:

  1. The fastify web framework for Node.js
  2. The liquidjs templating engine
  3. The progressbar.js library for shaped progress bars
  4. The node-sqlite3 client library to interact with the SQLite persistence engine
  5. The sparkline library to draw the progress rate graph for each task

Migrations

ProGBarZ supports a very simple strategy for database migrations via the command:

npm run migrate -- --db=<database>

where <database> is the absolute path to the target SQLite database file.

When invoked, the command will process in ascending sequence all the files in the sql directory that match the pattern migration_<four digits>.sql, e.g. migration_0012.sql, starting from migration_0000.sql.

Specifying the optional parameter --start=<number> to the migrate command will begin migration from the file migration_<number>.sql.

Example

Run all migrations found in the project's sql directory starting from migration_0012.sql where the target database is in /opt/mydb.sqlite:

npm run migrate -- --db=/opt/mydb.sqlite --start=12

UI

Project overall progress

When creating a new project from the sidenav bar you are prompted twice for input: the first prompt asks for the project's name, the second for the duration, in days, of the project if known - it may be left blank. If a duration in days is specified, ProGBarZ will track the number of days elapsed since creation of the project and displays this as a percentage relative to project duration as a semicircle progress bar above the task list.

Sparklines

Sparklines next to each task highlight the progress rate for each task. Large spikes denote that large chunks of progress were logged in a relatively short amount of time - the higher the value, the faster you are progressing through your task.

About

Create task lists with associated progress bars.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  
0