Skip to content

jeffd-dev/checklist_collection

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Checklist Collection

This is one page standalone web-app to display checklists.

This simple HTML5 web-app display checklists from embeded JSON

  • Embeded JSON: display checklists and share them to a team
  • Localstorage: allow any user to create their own personnal checklist, stored in the browser cache. (no form available)

Major features:

  • Display checks (with links) and color status (undone/done)
  • Can set condition (bool/checkbox) on a step to hide or display with ease
  • Can flag a step in case of review (question, doubt)
  • Responsive (with printable CSS)
  • Dark mode
  • No external dependencies (CDN, script, webfont...) or JS framework
  • Accessibility in mind
  • Work offline
  • Easy to understand, fork, adapt to your own needs

Installing

This application has no external requirements, you should simply deploy it on a webserver for a team usage. For personnal use you can open it with your browser.

This project include a checklist as example, embeded in the scripts.js file.

Usage

You can create a new checklist with Javascript function:

localSaveChecklist({"uid": "uniqueid", "name": "My Checklist", "steps": [{"content": "Hello world !"}]});

Check the embeded DATA checklists example in static/scripts.js.

Contributing

Merge request are not expected for a project as simple as this one, but you can open issue and purpose patch for usage (UX) or accessibility. If you fork this project to improve, open Issue, so I could reference your project as alternative inside this Readme.

Improvment

  • Description and links for a checklist
  • Option to display more info on a step item (with <summary>/<details> HTML item)
  • Accessibility (improved contrast color sheme) and color (darkmode/contrast) controls
  • Form to create a new checklist with ease
  • Checklist validation (linter for mandatory fields)

License

This project is licensed under the GPLv3 License - see the license description on GNU website for details

About

This project was developped as a code-kata in one day. A lot of things are perfectible.

About

Single page webapplication to display checklists

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published