A user-friendly and fluid interface for using checklists.
All the power of checklists, without the overhead:
- User-friendly and fluid interface
- Fast build with Preact and Milligram
- Generate PDF report
- Offline checklists storage with LocalStorage
- Auto-save your progress 🚀
- 💥 Instant no-config app bundling
Based on checklists:
- Front-End Checklist
- Search Engine Optimization
- API Security Checklist
- The Side Project Marketing Checklist
Use the online version: alexisdanizan.github.io
Install with npm
npm i checklist-tools-websiteInstall with Yarn
yarn add checklist-tools-websiteInstall manually
git clone https://github.com/AlexisDanizan/Checklist-Tools-Website.git
yarn install
# or
npm installBuild with Gulp
gulp buildBuilt files are available in dist folder.
Build and serve files with Gulp
gulp build
gulp webserverThe 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": "Front-dev",
"group_categories": [
{
"title_group": "Head",
"categories": [
{
"title": "Meta tags",
"tasks": [
{
"title": "Doctype",
"links": [
{"path":"https://www.w3.org/TR/html5/syntax.html#determining-the-character-encoding",
"text":"Determining the character encoding - HTML5 W3C",
"type": "link"}
],
"explications":"The Doctype is HTML5 and is at the top of all your HTML pages.",
"code":"<!doctype html> <!-- HTML5 -->",
"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:
const INITIAL_DATA = {
checklists: [
example
],
...
};The new checklist does not appear in select:
- Empty the localstorage before add a new checklist.
Open an issue or a pull request to suggest changes or additions.
The Checklist Tools Website repository consists of two branches:
This branch consists of the current stable branchof Checklist Tools Website.
This branch will be used to make some significant changes to the structure, content if needed. It is preferable to use the master branch to fix small errors or add a new checklist.
If you have any question or suggestion, don't hesitate to use Twitter:
This project exists thanks to all the people who contribute.
Designed and created with ♥ by Danizan Alexis. Licensed under the Apache 2.0 License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent