A user-friendly and fluid interface for using checklists.
Repository Status
Checklist/s Completion Status
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/
Install manually
git clone https://github.com/Thomas-A-Reinert/WordPress-Developer-Checklist.git
yarn install
# or
npm install
Build with Gulp
gulp build
Built files are available in dist
folder.
Build and serve files with Gulp
gulp build
gulp webserver
The version is available at http://localhost:8080
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.
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
],
...
};
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
Open an issue or a pull request to suggest changes or additions.
Designed and created with ♥ by Thomas A. Reinert. Licensed under the Apache 2.0 License.
This project wouldn´t exist without the selfless work of the following persons / projects:
- Code for the WordPress-Developer-Checklist based on the Front-End Checklist by Alexis Danizan
- Brian A. Danielak for his CONTRIBUTING.md Template
- Phillip Johnston for his PULL_REQUEST_TEMPLATE.md
- The people from Twitter for their Code-of-Conduct,
Attribution: "@TwitterOSS Code of Conduct" © 2013 Twitter, Inc, used under a Creative Commons Attribution Unported license: http://creativecommons.org/licenses/by/3.0/