A checklist meant for WordPress developers. Written in Preact, using Bootstrap and saving your settings in localStorage. See Demo at:
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
bin
data
dist
src
.babelrc
.editorconfig
.eslintrc.json
.gitignore
.travis.yml
CODE-OF-CONDUCT.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md
LICENSE
PULL_REQUEST_TEMPLATE.md
README.md
gulpfile.js
package.json

README.md

WordPress-Developer-Checklist

A user-friendly and fluid interface for using checklists.

>WordPress-Developer-Checklist

Repository Status

License GitHub release GitHub commits Last deployed Build Status GitHub issues

GitHub forks GitHub stars GitHub watchers GitHub followers GitHub contributors

Checklist/s Completion Status

Prerequisites, Installation & Post-Install Development Security Performance Theme-Development Plugin-Development

All the power of checklists, without the overhead:

  • User-friendly and fluid interface
  • Fast build with Preact and Bootstrap4
  • Generate PDF report
  • Offline checklists storage with LocalStorage
  • Auto-save your progress
  • Instant no-config app bundling

Use the online version: wpchecklist.tarthemes.com/

Installation

Install manually

git clone https://github.com/Thomas-A-Reinert/WordPress-Developer-Checklist.git
yarn install
# or
npm install

How to use ?

Build with Gulp

gulp build

Built files are available in dist folder.

Customize

Build and serve files with Gulp

gulp build
gulp webserver

The version is available at http://localhost:8080

Add a new Checklist

Use the auto-converter

To convert a checklist to markdown format you can use the bin/mdChecklistToJson.js script. To do this, add your checklist in sample.md and run the command npm mdtojson. The result of the conversion is in bin/sample.json. Modify your checklist until you get the result.

Add manually

Create a new json files in src/checklist. Sample template:

{
  "name": "Prerequisites, Installation & Post-Install",
  "description": "This checklist describes the WordPress installation prerequisites and installation process as well as post-install tasks.",
  "summary": "",
  "group_categories": [
    {
      "title_group": "WordPress Prerequisites",
      "categories": [
        {
          "title": "WordPress installation requirements",
          "tasks": [
            {
              "title": "Minimum hosting requirements",
              "explications":"Make sure your hosting plan at least supports the following setup. But you should make sure you fulfill the recommended setup. Note: Administrative tasks may consume much more memory!",
              "explicationlist": [
                {"explicationitem": "PHP 5.2.4 or greater"},
                {"explicationitem": "MySQL 5.0 or greater"},
                {"explicationitem": "Nginx or Apache with mod_rewrite module"},
                {"explicationitem": "Minimum 40MB memory allocated to PHP for a single sites (at least 64MB for multisite)"},
                {"explicationitem": "At least 60s PHP max execution time"},
                {"explicationitem": "HTTPS support"}
              ],
              "links": [
                {"path":"https://wordpress.org/about/requirements/",
                  "text":"WordPress.org - \"Requirements\"",
                  "type": "codex"},
                {"path":"https://codex.wordpress.org/Editing_wp-config.php#Increasing_memory_allocated_to_PHP",
                  "text":"WordPress.org - \"Increasing memory allocated to PHP\"",
                  "type": "codex"}
              ],
              "code":"",
              "priority": "high"
            },
          ]
        }
      ]
    }
  ]
}

To make the checklist available in app you need to modify ./src/stores/checklistStore.js and add import example from '../checklist/example.json';.

Next add it in INITIAL_DATA in ./src/stores/checklistStore.js:

const INITIAL_DATA = {
  checklists: [
    example
  ],
  ...
};

Troubleshooting

The new checklist does not appear in select:

  • Empty the localStorage before add a new checklist.
  • Try the Chrome extension "Clear Session" to clear the localStorage for the current window

Contributing

Open an issue or a pull request to suggest changes or additions.

Support

Author

Thomas A. Reinert

License

Designed and created with ♥ by Thomas A. Reinert. Licensed under the Apache 2.0 License.

Credits

This project wouldn´t exist without the selfless work of the following persons / projects: