├── .babelrc
├── .eslintrc.json
├── .gitignore
├── LICENSE
├── README.md
├── bin
├── mdChecklistToJson.js
└── sample.md
├── data
└── checklist-tools.gif
├── gulpfile.js
├── package.json
└── src
├── assets
├── img
│ ├── favicon
│ │ ├── android-icon-144x144.png
│ │ ├── android-icon-192x192.png
│ │ ├── android-icon-36x36.png
│ │ ├── android-icon-48x48.png
│ │ ├── android-icon-72x72.png
│ │ ├── android-icon-96x96.png
│ │ ├── apple-icon-114x114.png
│ │ ├── apple-icon-120x120.png
│ │ ├── apple-icon-144x144.png
│ │ ├── apple-icon-152x152.png
│ │ ├── apple-icon-180x180.png
│ │ ├── apple-icon-57x57.png
│ │ ├── apple-icon-60x60.png
│ │ ├── apple-icon-72x72.png
│ │ ├── apple-icon-76x76.png
│ │ ├── apple-icon-precomposed.png
│ │ ├── apple-icon.png
│ │ ├── browserconfig.xml
│ │ ├── favicon-16x16.png
│ │ ├── favicon-32x32.png
│ │ ├── favicon-96x96.png
│ │ ├── favicon.ico
│ │ ├── manifest.json
│ │ ├── ms-icon-144x144.png
│ │ ├── ms-icon-150x150.png
│ │ ├── ms-icon-310x310.png
│ │ └── ms-icon-70x70.png
│ └── logo.png
└── sass
│ ├── _Color.scss
│ ├── _custom.scss
│ ├── _print.scss
│ └── main.scss
├── checklist
├── api-security.json
├── front-end.json
├── seo.json
└── side-project-marketing.json
├── components
├── category.js
├── details.js
├── groupCategories.js
├── header.js
├── status.js
├── subCategories.js
├── task.js
└── toolbar.js
├── data
└── index.js
├── index.js
├── reducers
└── checklist.js
├── stores
├── checklistStore.js
├── manage.js
├── storage.js
└── type.js
├── templates
└── index.html
└── utils.js
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "sourceMaps": true,
3 | "presets": [
4 | "react",
5 | "stage-0",
6 | ["es2015", { "loose":true }]
7 | ],
8 | "plugins": [
9 | "transform-decorators-legacy",
10 | ["transform-react-jsx", { "pragma": "h" }]
11 | ]
12 | }
--------------------------------------------------------------------------------
/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "plugins": ["prettier"],
3 | "extends": ["react","prettier"],
4 | "rules": {
5 | "prettier/prettier": "error",
6 | "react/jsx-filename-extension": [1, { "extensions": [".js", ".jsx"] }]
7 | }
8 | }
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | dist/
3 | npm-debug.log
4 | yarn-error.log
5 | package-lock.json
6 | yarn.lock
7 |
8 | # Editor directories and files
9 | .idea
10 | *.suo
11 | *.ntvs*
12 | *.njsproj
13 | *.sln
14 | *.iml
15 | *.sync
16 | src/assets/css/main.css
17 |
18 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
11 |
12 |
13 | [](https://github.com/AlexisDanizan/Checklist-Tools-Website/blob/master/LICENSE)
14 | [](https://github.com/thedaviddias/Front-End-Checklist/)
15 | [](https://github.com/AlexisDanizan/Checklist-Tools-Website/issues)
16 | [](https://github.com/AlexisDanizan/Checklist-Tools-Website/stargazers)
17 | [](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FAlexisDanizan%2FChecklist-Tools-Website)
18 |
19 | **All the power of checklists, without the overhead:**
20 | - User-friendly and fluid interface
21 | - Fast build with [Preact]() and [Milligram](https://github.com/milligram/milligram)
22 | - Generate PDF report
23 | - Offline checklists storage with LocalStorage
24 | - Auto-save your progress 🚀
25 | - 💥 **Instant no-config app bundling**
26 |
27 | Based on checklists:
28 | - [Front-End Checklist](https://github.com/thedaviddias/Front-End-Checklist)
29 | - [Search Engine Optimization](https://github.com/marcobiedermann/search-engine-optimization)
30 | - [API Security Checklist](https://github.com/shieldfy/API-Security-Checklist)
31 | - [The Side Project Marketing Checklist](https://github.com/karllhughes/side-project-marketing)
32 |
33 | ### Use the online version: [alexisdanizan.github.io](https://alexisdanizan.github.io)
34 |
35 |
36 | ## Installation
37 |
38 | **Install with npm**
39 | ```bash
40 | npm i checklist-tools-website
41 | ```
42 |
43 | **Install with Yarn**
44 | ```bash
45 | yarn add checklist-tools-website
46 | ```
47 |
48 | **Install manually**
49 |
50 | ```bash
51 | git clone https://github.com/AlexisDanizan/Checklist-Tools-Website.git
52 | yarn install
53 | # or
54 | npm install
55 | ```
56 |
57 | ## How to use ?
58 |
59 | **Build with [Gulp](https://github.com/gulpjs/gulp)**
60 | ```bash
61 | gulp build
62 | ```
63 | Built files are available in `dist` folder.
64 |
65 | ## Customize
66 |
67 | **Build and serve files with [Gulp](https://github.com/gulpjs/gulp)**
68 | ```bash
69 | gulp build
70 | gulp webserver
71 | ```
72 |
73 | The version is available at [http://localhost:8080](http://localhost:8080)
74 |
75 | ### Add a new Checklist
76 |
77 | #### Use the auto-converter
78 |
79 | To convert a checklist to markdown format you can use the `bin/mdChecklistToJson.js` script.
80 | To do this, add your checklist in `sample.md` and run the command **`npm mdtojson`**.
81 | The result of the conversion is in **`bin/sample.json`**. Modify your checklist until you get the result.
82 |
83 | #### Add manually
84 |
85 | Create a new json files in `src/checklist`.
86 | Sample template:
87 | ```json
88 | {
89 | "name": "Front-dev",
90 | "group_categories": [
91 | {
92 | "title_group": "Head",
93 | "categories": [
94 | {
95 | "title": "Meta tags",
96 | "tasks": [
97 | {
98 | "title": "Doctype",
99 | "links": [
100 | {"path":"https://www.w3.org/TR/html5/syntax.html#determining-the-character-encoding",
101 | "text":"Determining the character encoding - HTML5 W3C",
102 | "type": "link"}
103 | ],
104 | "explications":"The Doctype is HTML5 and is at the top of all your HTML pages.",
105 | "code":" ",
106 | "priority": "high"
107 | }
108 | ]
109 | }
110 | ]
111 | }
112 | ]
113 | }
114 | ```
115 |
116 | To make the checklist available in app you need to modify `src/stores/checklistStore.js`
117 | and add `import example from '../checklist/example.json';`.
118 |
119 | Next add it in INITIAL_DATA:
120 | ```js
121 | const INITIAL_DATA = {
122 | checklists: [
123 | example
124 | ],
125 | ...
126 | };
127 | ```
128 |
129 | ## Troubleshooting
130 |
131 | The new checklist does not appear in select:
132 | - Empty the localstorage before add a new checklist.
133 |
134 | ## Contributing
135 |
136 | **Open an issue or a pull request to suggest changes or additions.**
137 |
138 | ### Guide
139 |
140 | The **Checklist Tools Website** repository consists of two branches:
141 |
142 | #### 1. `master`
143 |
144 | This branch consists of the current stable branchof [Checklist Tools Website](https://github.com/AlexisDanizan/Checklist-Tools-Website).
145 |
146 | #### 2. `develop`
147 |
148 | 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.
149 |
150 | ## Support
151 |
152 | If you have any question or suggestion, don't hesitate to use Twitter:
153 | * [Twitter](https://twitter.com/alexisdanizan)
154 |
155 | ## Author
156 |
157 | **[Alexis Danizan](https://github.com/AlexisDanizan)**
158 |
159 | ## Contributors
160 |
161 | This project exists thanks to all the people who contribute.
162 |
163 | ## License
164 |
165 | Designed and created with ♥ by Danizan Alexis. Licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
--------------------------------------------------------------------------------
/bin/mdChecklistToJson.js:
--------------------------------------------------------------------------------
1 | var md = require( "markdown" ).markdown;
2 | var fs = require('fs');
3 | fs.readFile( __dirname + '/sample.md', function (err, data) {
4 | if (err) {
5 | throw err;
6 | }
7 | var tree = md.parse( data.toString() );
8 | var json = {
9 | name:"",
10 | group_categories: []
11 | };
12 | var current_categories = -1;
13 | var current_group_categories = -1;
14 | var current_task= -1;
15 | var current_links = -1;
16 | tree.map((group,i) => {
17 | if(group[0] === 'header'){
18 | if(group[1].level === 1){
19 | json.name = group[2];
20 |
21 | }
22 | if(group[1].level === 2 ){
23 | current_group_categories++;
24 | current_categories = -1;
25 | json.group_categories[current_group_categories] = {title_group: group[2],categories:[]};
26 | }
27 | if(group[1].level === 3){
28 | current_categories++;
29 | current_task=-1;
30 | json.group_categories[current_group_categories].categories[current_categories] = {title: group[2], tasks: []};
31 | }
32 | }
33 | if(group[0] === 'bulletlist'){
34 | group.map((line) =>{
35 | current_links = -1;
36 | if(line !== 'bulletlist'){
37 | current_task++;
38 | json.group_categories[current_group_categories].categories[current_categories].tasks[current_task]={priority: "medium"};
39 |
40 | line.map((item) => {
41 | console.log(item);
42 | if(item !== 'listitem'){
43 | if(item instanceof Array){
44 | if(item[0] === 'inlinecode'){
45 | if(json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].title === undefined){
46 | json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].title = "";
47 | }
48 | json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].title += item[1];
49 | }
50 | if(item[0] === 'link'){
51 | current_links++;
52 | if(json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].links === undefined){
53 | json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].links = [];
54 | }
55 | json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].links[current_links] = {
56 | path: item[1].href,
57 | text: item[2],
58 | type: "link"
59 | };
60 | }
61 | }else{
62 | if(json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].title === undefined){
63 | json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].title = "";
64 | }
65 | json.group_categories[current_group_categories].categories[current_categories].tasks[current_task].title += item;
66 | }
67 | }
68 | });
69 | }
70 | });
71 | }
72 | });
73 |
74 | fs.writeFile("sample.json", JSON.stringify(json), function(err) {
75 | if(err) {
76 | throw err;
77 | }
78 | console.log("The file was converted and saved in bin/sample.json !");
79 | });
80 | });
81 |
--------------------------------------------------------------------------------
/bin/sample.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/bin/sample.md
--------------------------------------------------------------------------------
/data/checklist-tools.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/data/checklist-tools.gif
--------------------------------------------------------------------------------
/gulpfile.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 | const gulp = require('gulp');
3 | const nunjucks = require('gulp-nunjucks');
4 | const imagemin = require('gulp-imagemin');
5 | const htmlmin = require('gulp-htmlmin');
6 | const browserify = require('browserify');
7 | const babel = require('babelify');
8 | const uglify = require('gulp-uglify');
9 | const source = require('vinyl-source-stream');
10 | const buffer = require('vinyl-buffer');
11 | const sass = require('gulp-sass');
12 | const uncss = require('uncss').postcssPlugin;
13 | const concat = require('gulp-concat');
14 | const webserver = require('gulp-webserver');
15 | const postcss = require('gulp-postcss');
16 | const sourcemaps = require('gulp-sourcemaps');
17 | const autoprefixer = require('autoprefixer');
18 | const nano = require('cssnano');
19 | const clean = require('gulp-clean');
20 | const data = require('./src/data/index');
21 |
22 | const PATH = {
23 | "DIST": "./dist",
24 | "TEMPLATES": "./src/templates/*.html",
25 | "JS": "./src/index.js",
26 | "IMG": "./src/assets/img/**/*",
27 | "FONTS": "./node_modules/font-awesome/fonts/**/*",
28 | "SASS": "./src/assets/sass/main.scss",
29 | "SASS_DIST": "./src/assets/css",
30 | "NORMALIZE_CSS": "./node_modules/normalize.css/normalize.css",
31 | };
32 |
33 | process.env.NODE_ENV = 'production';
34 |
35 | /**
36 | * Clean dist folder
37 | */
38 | gulp.task('clean', () => {
39 | return gulp.src(PATH.DIST, {read: false}).pipe(clean());
40 | });
41 |
42 | /**
43 | * Compile html and minify
44 | */
45 | gulp.task('html', ['clean'], () => {
46 | gulp.src(PATH.TEMPLATES)
47 | .pipe(nunjucks.compile(data))
48 | .pipe(htmlmin({collapseWhitespace: true,removeComments: true}))
49 | .pipe(gulp.dest(PATH.DIST));
50 | });
51 |
52 | /**
53 | * Copy fonts files
54 | */
55 | gulp.task('fonts', ['clean'], () => {
56 | return gulp.src(PATH.FONTS).pipe(gulp.dest(PATH.DIST + '/fonts'));
57 | });
58 |
59 | /**
60 | * Copy and reduce image size
61 | */
62 | gulp.task('images', ['clean'], () => {
63 | gulp.src(PATH.IMG)
64 | .pipe(imagemin([
65 | imagemin.gifsicle({interlaced: true}),
66 | imagemin.jpegtran({progressive: true, max: 75}),
67 | imagemin.optipng({optimizationLevel: 7}),
68 | ]))
69 | .pipe(gulp.dest( PATH.DIST + '/img'));
70 | });
71 |
72 | /**
73 | * Compile and minify js
74 | */
75 | gulp.task('js',['html'], () => {
76 | return browserify({ debug: (process.env.NODE_ENV === 'production') })
77 | .transform(babel)
78 | .require(PATH.JS, { entry: true })
79 | .bundle()
80 | .on("error", function (err) { console.log("Error: " + err.message); })
81 | .pipe(source('bundle.js'))
82 | .pipe(buffer())
83 | .pipe(uglify())
84 | .pipe(gulp.dest(PATH.DIST + "/js"));
85 | });
86 |
87 | /**
88 | * Compile sass and remove unused rules
89 | */
90 | gulp.task('sass',['js', 'html'], () =>
91 | gulp.src(PATH.SASS)
92 | .pipe(sass().on('error', sass.logError))
93 | .pipe(concat('main.css'))
94 | .pipe(postcss([ autoprefixer({
95 | browsers: ['last 2 versions'],
96 | cascade: false
97 | }),
98 | uncss({
99 | html: [PATH.DIST + '/*.html'],
100 | ignore: [/^\.fa-angle-*/,/^\.fa-external-link$/,/\.checked/,/^\.fa-book$/,/^\.fa-wrench$/,/^\.fa-check$/,/fa-ul/, /fa-li/,/^blockquote/,/^pre/,/^code/,/^em/]
101 | })
102 | ]))
103 | .pipe(gulp.dest(PATH.SASS_DIST ))
104 | );
105 |
106 | /**
107 | * Add cross-browser rules, and minify css
108 | */
109 | gulp.task('postcss',['sass','js'], () =>
110 | gulp.src([PATH.NORMALIZE_CSS,PATH.SASS_DIST +"/main.css"])
111 | .pipe(concat('main.css'))
112 | .pipe(sourcemaps.init())
113 | .pipe(postcss([nano(),]))
114 | .pipe(sourcemaps.write('.'))
115 | .pipe(gulp.dest(PATH.DIST + "/css"))
116 | );
117 |
118 |
119 | gulp.task('webserver', function() {
120 | gulp.src(PATH.DIST)
121 | .pipe(webserver({
122 | livereload: true,
123 | open: true,
124 | port: 8080,
125 | }));
126 | });
127 |
128 | gulp.task('build', [
129 | 'clean',
130 | 'html',
131 | 'fonts',
132 | 'images',
133 | 'js',
134 | 'sass',
135 | 'postcss',
136 | ]);
137 |
138 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "checklist-tools-website",
3 | "version": "0.0.4",
4 | "description": "The perfect Checklist Website for meticulous developers.",
5 | "main": "src/index.js",
6 | "scripts": {
7 | "test": "echo \"Error: no test specified\" && exit 1",
8 | "lint": "node ./node_modules/eslint/bin/eslint.js src/**/*.js",
9 | "mdtojson": "node mdChecklistToJson.js"
10 | },
11 | "author": "Alexis Danizan",
12 | "license": "ISC",
13 | "browser": {
14 | "materialize": "./node_modules/materialize-css/dist/js/materialize.js"
15 | },
16 | "browserify-shim": {
17 | "materialize": "M"
18 | },
19 | "browserify": {
20 | "transform": [
21 | "browserify-shim",
22 | [
23 | "babelify",
24 | {
25 | "comments": false
26 | }
27 | ]
28 | ]
29 | },
30 | "devDependencies": {
31 | "autoprefixer": "^7.2.5",
32 | "babel-core": "^6.26.0",
33 | "babel-eslint": "^8.2.1",
34 | "babel-plugin-transform-decorators-legacy": "^1.3.4",
35 | "babel-plugin-transform-react-jsx": "^6.24.1",
36 | "babel-preset-env": "^1.6.1",
37 | "babel-preset-es2015": "^6.24.1",
38 | "babel-preset-react": "^6.24.1",
39 | "babel-preset-stage-0": "^6.24.1",
40 | "babelify": "^8.0.0",
41 | "browserify": "^15.2.0",
42 | "browserify-shim": "^3.8.14",
43 | "cssnano": "^3.10.0",
44 | "decko": "^1.2.0",
45 | "eslint": "^4.15.0",
46 | "eslint-config-airbnb": "^16.1.0",
47 | "eslint-config-prettier": "^2.9.0",
48 | "eslint-config-react": "^1.1.7",
49 | "eslint-plugin-import": "^2.8.0",
50 | "eslint-plugin-jsx-a11y": "^6.0.3",
51 | "eslint-plugin-prettier": "^2.5.0",
52 | "eslint-plugin-react": "^7.5.1",
53 | "gulp": "^3.9.1",
54 | "gulp-clean": "^0.4.0",
55 | "gulp-concat": "^2.6.1",
56 | "gulp-htmlmin": "^4.0.0",
57 | "gulp-imagemin": "^4.1.0",
58 | "gulp-nunjucks": "^3.1.1",
59 | "gulp-postcss": "^7.0.1",
60 | "gulp-sass": "^3.1.0",
61 | "gulp-sourcemaps": "^2.6.3",
62 | "gulp-uglify": "^3.0.0",
63 | "gulp-webserver": "^0.9.1",
64 | "markdown": "^0.5.0",
65 | "prettier": "1.10.2",
66 | "reactify": "^1.1.1",
67 | "uncss": "^0.16.1",
68 | "vinyl-buffer": "^1.0.1",
69 | "vinyl-source-stream": "^2.0.0"
70 | },
71 | "dependencies": {
72 | "font-awesome": "^4.7.0",
73 | "milligram": "^1.3.0",
74 | "normalize.css": "^7.0.0",
75 | "preact": "^8.2.7",
76 | "preact-cycle": "^0.5.1"
77 | }
78 | }
79 |
--------------------------------------------------------------------------------
/src/assets/img/favicon/android-icon-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/android-icon-144x144.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/android-icon-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/android-icon-192x192.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/android-icon-36x36.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/android-icon-36x36.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/android-icon-48x48.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/android-icon-48x48.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/android-icon-72x72.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/android-icon-72x72.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/android-icon-96x96.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/android-icon-96x96.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-114x114.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-114x114.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-120x120.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-120x120.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-144x144.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-152x152.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-152x152.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-180x180.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-180x180.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-57x57.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-57x57.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-60x60.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-60x60.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-72x72.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-72x72.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-76x76.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-76x76.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon-precomposed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon-precomposed.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/apple-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/apple-icon.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/browserconfig.xml:
--------------------------------------------------------------------------------
1 |
2 | #ffffff
--------------------------------------------------------------------------------
/src/assets/img/favicon/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/favicon-16x16.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/favicon-32x32.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/favicon-96x96.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/favicon-96x96.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/favicon.ico
--------------------------------------------------------------------------------
/src/assets/img/favicon/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "App",
3 | "icons": [
4 | {
5 | "src": "\/android-icon-36x36.png",
6 | "sizes": "36x36",
7 | "type": "image\/png",
8 | "density": "0.75"
9 | },
10 | {
11 | "src": "\/android-icon-48x48.png",
12 | "sizes": "48x48",
13 | "type": "image\/png",
14 | "density": "1.0"
15 | },
16 | {
17 | "src": "\/android-icon-72x72.png",
18 | "sizes": "72x72",
19 | "type": "image\/png",
20 | "density": "1.5"
21 | },
22 | {
23 | "src": "\/android-icon-96x96.png",
24 | "sizes": "96x96",
25 | "type": "image\/png",
26 | "density": "2.0"
27 | },
28 | {
29 | "src": "\/android-icon-144x144.png",
30 | "sizes": "144x144",
31 | "type": "image\/png",
32 | "density": "3.0"
33 | },
34 | {
35 | "src": "\/android-icon-192x192.png",
36 | "sizes": "192x192",
37 | "type": "image\/png",
38 | "density": "4.0"
39 | }
40 | ]
41 | }
--------------------------------------------------------------------------------
/src/assets/img/favicon/ms-icon-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/ms-icon-144x144.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/ms-icon-150x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/ms-icon-150x150.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/ms-icon-310x310.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/ms-icon-310x310.png
--------------------------------------------------------------------------------
/src/assets/img/favicon/ms-icon-70x70.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/favicon/ms-icon-70x70.png
--------------------------------------------------------------------------------
/src/assets/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/AlexisDanizan/Checklist-Tools-Website/a32bb8c519201b6bd86f41a71aa8966ff3c894ef/src/assets/img/logo.png
--------------------------------------------------------------------------------
/src/assets/sass/_Color.scss:
--------------------------------------------------------------------------------
1 |
2 | // Color
3 | // ––––––––––––––––––––––––––––––––––––––––––––––––––
4 |
5 | $color-initial: #fff !default;
6 | $color-primary: $green !default;
7 | $color-secondary: $blue !default;
8 | $color-tertiary: #f4f5f6 !default;
9 | $color-quaternary: #d1d1d1 !default;
10 | $color-quinary: #e1e1e1 !default;
11 |
--------------------------------------------------------------------------------
/src/assets/sass/_custom.scss:
--------------------------------------------------------------------------------
1 |
2 |
3 | $white: #fff;
4 | $blue: #324D5C;
5 | $green: #46B29D;
6 | $yellow: #F0CA4D;
7 | $orange: #E37B40;
8 | $red: #F53855;
9 | $grey: #c0c5ce;
10 | $navbar-size: 50px;
11 | $navbar-bg-color: $blue;
12 | $navbar-typo-color: $white;
13 | $navbar-link-hover: $green;
14 | $navbar-link-margin: 2rem;
15 | $navbar-brand-font-size: 2.8rem;
16 |
17 | $header-bg-color: $grey;
18 | $header-bg-input: rgba(255,255,255,0.2);
19 |
20 | $footer-bg-color: $grey;
21 | $footer-size: 60px;
22 | body,html,main {
23 | width: 100%;
24 | height: 100%;
25 | background-color: $white;
26 | line-height: 1.15;
27 | }
28 |
29 | #app {
30 | margin-top: -$navbar-size;
31 | padding-top: $navbar-size;
32 | min-height: 100%;
33 | padding-bottom: 2*$footer-size;
34 | }
35 |
36 | .hide-on-mobile{
37 | @media (max-width: 40.0rem) {
38 | display: none;
39 | }
40 | }
41 | .show-on-mobile{
42 | @media (max-width: 40.0rem) {
43 | max-width: 100% !important;
44 | }
45 | }
46 |
47 | nav {
48 | height: $navbar-size;
49 | background-color: $navbar-bg-color;
50 | /*** GITHUb button **/
51 | iframe {
52 | margin-top: ($navbar-size - 28)/2;
53 | margin-right: $navbar-link-margin;
54 | }
55 |
56 | .navbar-link, .brand {
57 | color: $navbar-typo-color;
58 | line-height: $navbar-size;
59 | }
60 | .brand {
61 | font-size: $navbar-brand-font-size;
62 | text-transform: uppercase;
63 | &:hover{
64 | color: $grey;
65 | }
66 | }
67 | .navbar-link {
68 | margin-right: $navbar-link-margin;
69 | transition: all 0.3s ease;
70 | }
71 | .navbar-link:hover {
72 | color: $navbar-link-hover;
73 | }
74 | i.fa {
75 | vertical-align: middle;
76 | }
77 | }
78 |
79 | header {
80 | background-color: $header-bg-color;
81 | .checklist-name {
82 | text-align: center;
83 | padding: 1rem;
84 | }
85 | input, select {
86 | background-color: $header-bg-input !important;
87 | }
88 | .button {
89 | margin-right: 1rem;
90 | i.fa {
91 | margin-right: 10px;
92 | }
93 | }
94 | .toolbar {
95 | div.button-toolbar {
96 | padding-top: 24px;
97 | }
98 | }
99 | .status {
100 | i.fa {
101 | margin-right: 10px;
102 | }
103 | i.high {
104 | color: $red;
105 | }
106 | i.medium {
107 | color: $orange;
108 | }
109 | i.low {
110 | color: $green;
111 | }
112 | }
113 | }
114 |
115 | .categories {
116 | width: 90%;
117 | margin: auto;
118 | h1 {
119 | margin-top: 3rem;
120 | text-transform: uppercase;
121 | &.group-title {
122 | font-weight: bold;
123 | border-bottom: solid 1px $grey;
124 | & .go-top {
125 | font-size: 2rem;
126 | text-transform: none;
127 | vertical-align: middle;
128 | transition: all 0.2s ease;
129 | &:hover {
130 | color: $orange;
131 | }
132 | }
133 | }
134 |
135 | }
136 | .task {
137 | p, i.fa {
138 | margin-bottom: 0.5rem;
139 | cursor: pointer;
140 | }
141 | i.fa {
142 | color: $yellow;
143 | margin: 0 0.5rem 0 0.5rem;
144 | }
145 | i.checked {
146 | color: $green;
147 | text-decoration: none;
148 | &.high {
149 | color: $red;
150 | }
151 | &.medium {
152 | color: $orange;
153 | }
154 | &.low {
155 | color: $green;
156 | }
157 | }
158 | i.not-checked {
159 | color: $grey;
160 | opacity: 0.5;
161 | &.high {
162 | color: $red;
163 | }
164 | &.medium {
165 | color: $orange;
166 | }
167 | &.low {
168 | color: $green;
169 | }
170 | }
171 | span.checked {
172 | text-decoration: line-through;
173 | }
174 | }
175 | }
176 |
177 | footer {
178 | left: 0;
179 | bottom: 0;
180 | width: 100%;
181 | height: $footer-size;
182 | margin-top: -$footer-size;
183 | text-align: center;
184 | background-color: $grey;
185 | p {
186 | margin: 0;
187 | height: $footer-size;
188 | line-height: $footer-size;
189 | color: $blue;
190 | }
191 | .heart {
192 | color: $red;
193 | }
194 |
195 | }
196 |
197 | .for-print {
198 | display: none !important;
199 | }
--------------------------------------------------------------------------------
/src/assets/sass/_print.scss:
--------------------------------------------------------------------------------
1 | @media only print
2 | {
3 | .for-print{
4 | display: block !important;
5 | }
6 | nav,
7 | .details,
8 | .toolbar{
9 | display: none !important;
10 | }
11 | .no-print{
12 | display: none !important;
13 | }
14 | .categories{
15 | width: 100% !important;
16 | margin: 0;
17 | h1{
18 | font-size: 2rem;
19 | a.go-top{
20 | display: none !important;
21 | }
22 | }
23 |
24 | }
25 | .container{
26 | width: 100% !important;
27 | padding: 0 !important;
28 | }
29 | .task{
30 | .task-details{
31 | display: none !important;
32 | }
33 | p{
34 | font-size: 1.5rem;
35 | }
36 | p span.checked{
37 | text-decoration: none !important;
38 | }
39 | i.fa-angle-down, i.fa-angle-left{
40 | display: none !important;
41 | }
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/src/assets/sass/main.scss:
--------------------------------------------------------------------------------
1 | @import "node_modules/font-awesome/scss/font-awesome.scss";
2 | @import "custom";
3 | @import "Color";
4 | @import "print";
5 | @import "node_modules/milligram/src/milligram.sass";
6 |
7 |
8 |
--------------------------------------------------------------------------------
/src/checklist/api-security.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "API Security Checklist",
3 | "group_categories": [
4 | {
5 | "title_group": "Authentication",
6 | "categories": [
7 | {
8 | "title": "Authentication",
9 | "tasks": [
10 | {
11 | "priority": "high",
12 | "title": "No Basic Auth",
13 | "explications":"Don't use Basic Auth Use standard authentication",
14 | "links": [
15 | {
16 | "path": "https://jwt.io/",
17 | "text": "JWT",
18 | "type": "link"
19 | },
20 | {
21 | "path": "https://oauth.net/",
22 | "text": "OAuth",
23 | "type": "link"
24 | }
25 | ]
26 | },
27 | {
28 | "priority": "high",
29 | "title": "Standards Authentication",
30 | "explications":"Don't reinvent the wheel in Authentication, token generation, password storage. Use the standards."
31 | },
32 | {
33 | "priority": "medium",
34 | "title": "Max Retry",
35 | "explications":"Use Max Retry and jail features in Login."
36 | },
37 | {
38 | "priority": "high",
39 | "title": "Encryption",
40 | "explications":"Use encryption on all sensitive data."
41 | }
42 | ]
43 | },
44 | {
45 | "title": "JSON Web Token (JWT)",
46 | "tasks": [
47 | {
48 | "priority": "high",
49 | "title": "Random complicated key",
50 | "explications":"Use a random complicated key (JWT Secret) to make brute forcing the token very hard."
51 | },
52 | {
53 | "priority": "high",
54 | "title": "Don't extract the algorithm from the payload",
55 | "explications":"Don't extract the algorithm from the payload. Force the algorithm in the backend (HS256 or RS256)."
56 | },
57 | {
58 | "priority": "high",
59 | "title": "Token expiration (TTL, RTTL)",
60 | "explications":"Make token expiration (TTL, RTTL) as short as possible.."
61 | },
62 | {
63 | "priority": "high",
64 | "title": "No sensitive data store",
65 | "explications":"Don't store sensitive data in the JWT payload, it can be decoded .",
66 | "links": [
67 | {
68 | "path": "https://jwt.io/#debugger-io",
69 | "text": "easily",
70 | "type": "link"
71 | }
72 | ]
73 | }
74 | ]
75 | },
76 | {
77 | "title": "OAuth",
78 | "tasks": [
79 | {
80 | "priority": "medium",
81 | "explications":"Always validate redirect_uri server-side to allow only whitelisted URLs.",
82 | "title": "Always validate redirect_uri"
83 | },
84 | {
85 | "priority": "medium",
86 | "explications":"Always try to exchange for code and not tokens (don't allow response_type=token).",
87 | "title": "No exchange tokens"
88 | },
89 | {
90 | "priority": "high",
91 | "explications":"Use state parameter with a random hash to prevent CSRF on the OAuth authentication process.",
92 | "title": "State parameter with a random hash"
93 | },
94 | {
95 | "priority": "medium",
96 | "explications":"Define the default scope, and validate scope parameters for each application.",
97 | "title": "Define the default and validate scope"
98 | }
99 | ]
100 | }
101 | ]
102 | },
103 | {
104 | "title_group": "Access",
105 | "categories": [
106 | {
107 | "title": "Access",
108 | "tasks": [
109 | {
110 | "priority": "high",
111 | "explications": "Limit requests (Throttling) to avoid DDoS / brute-force attacks.",
112 | "title":"Limit requests (Throttling)"
113 | },
114 | {
115 | "priority": "high",
116 | "explications": "Use HTTPS on server side to avoid MITM (Man In The Middle Attack).",
117 | "title":"Use HTTPS"
118 | },
119 | {
120 | "priority": "medium",
121 | "explications": "Use HSTS header with SSL to avoid SSL Strip attack.",
122 | "title":"Use HSTS"
123 | }
124 | ]
125 | }
126 | ]
127 | },
128 | {
129 | "title_group": "Input",
130 | "categories": [
131 | {
132 | "title": "Input",
133 | "tasks": [
134 | {
135 | "priority": "high",
136 | "explications": "Use the proper HTTP method according to the operation: GET (read), POST (create), PUT/PATCH (replace/update), and DELETE (to delete a record), and respond with 405 Method Not Allowed if the requested method isn't appropriate for the requested resource.",
137 | "title":"Use the proper HTTP method"
138 | },
139 | {
140 | "priority": "high",
141 | "explications": "Validate content-type on request Accept header (Content Negotiation) to allow only your supported format (e.g. application/xml, application/json, etc) and respond with 406 Not Acceptable response if not matched.",
142 | "title":"Validate content-type on request"
143 | },
144 | {
145 | "priority": "medium",
146 | "explications": "Validate content-type of posted data as you accept (e.g. application/x-www-form-urlencoded, multipart/form-data, application/json, etc).",
147 | "title":"Validate content-type of posted data"
148 | },
149 | {
150 | "priority": "high",
151 | "explications": "Validate User input to avoid common vulnerabilities (e.g. XSS, SQL-Injection, Remote Code Execution, etc).",
152 | "title":"Validate User input"
153 | },
154 | {
155 | "priority": "high",
156 | "explications": "Don't use any sensitive data (credentials, Passwords, security tokens, or API keys) in the URL, but use standard Authorization header.",
157 | "title":"Don't use any sensitive data"
158 | },
159 | {
160 | "priority": "medium",
161 | "explications": "Use an API Gateway service to enable caching, Rate Limit policies (e.g. Quota, Spike Arrest, Concurrent Rate Limit) and deploy APIs resources dynamically.",
162 | "title":"Use an API Gateway service to enable caching"
163 | }
164 | ]
165 | }
166 | ]
167 | },
168 | {
169 | "title_group": "Processing",
170 | "categories": [
171 | {
172 | "title": "Processing",
173 | "tasks": [
174 | {
175 | "priority": "high",
176 | "explications": "Check if all the endpoints are protected behind authentication to avoid broken authentication process.",
177 | "title":"All the endpoints are protected behind auth"
178 | },
179 | {
180 | "priority": "high",
181 | "explications": "User own resource ID should be avoided. Use /me/orders instead of /user/654321/orders.",
182 | "title":"Avoid user own resource ID"
183 | },
184 | {
185 | "priority": "high",
186 | "explications": "Don't auto-increment IDs. Use UUID instead.",
187 | "title":"No auto-increment IDs"
188 | },
189 | {
190 | "priority": "medium",
191 | "explications": "If you are parsing XML files, make sure entity parsing is not enabled to avoid XXE (XML external entity attack).",
192 | "title":"No XML entity parsing"
193 | },
194 | {
195 | "priority": "medium",
196 | "explications": "If you are parsing XML files, make sure entity expansion is not enabled to avoid Billion Laughs/XML bomb via exponential entity expansion attack.",
197 | "title":"No XML entity expansion"
198 | },
199 | {
200 | "priority": "medium",
201 | "title": "Use a CDN for file uploads."
202 | },
203 | {
204 | "priority": "medium",
205 | "explications": "If you are dealing with huge amount of data, use Workers and Queues to process as much as possible in background and return response fast to avoid HTTP Blocking.",
206 | "title":"Use Workers and Queues"
207 | },
208 | {
209 | "priority": "high",
210 | "explications": "Do not forget to turn the DEBUG mode OFF.",
211 | "title":"DEBUG mode OFF"
212 | }
213 | ]
214 | }
215 | ]
216 | },
217 | {
218 | "title_group": "Output",
219 | "categories": [
220 | {
221 | "title": "Output",
222 | "tasks": [
223 | {
224 | "priority": "high",
225 | "explications": "Send X-Content-Type-Options: nosniff header.",
226 | "title":"X-Content-Type-Options"
227 | },
228 | {
229 | "priority": "high",
230 | "explications": "Send X-Frame-Options: deny header.",
231 | "title":"X-Frame-Options"
232 | },
233 | {
234 | "priority": "high",
235 | "explications": "Send Content-Security-Policy: default-src 'none' header.",
236 | "title":"Content-Security-Policy"
237 | },
238 | {
239 | "priority": "high",
240 | "explications": "Remove fingerprinting headers - X-Powered-By, Server, X-AspNet-Version etc.",
241 | "title":"Remove fingerprinting headers"
242 | },
243 | {
244 | "priority": "medium",
245 | "explications": "Force content-type for your response, if you return application/json then your response content-type is application/json.",
246 | "title":"Force content-type for response"
247 | },
248 | {
249 | "priority": "high",
250 | "explications": "Don't return sensitive data like credentials, Passwords, security tokens.",
251 | "title":"Don't return sensitive data"
252 | },
253 | {
254 | "priority": "high",
255 | "explications": "Return the proper status code according to the operation completed. (e.g. 200 OK, 400 Bad Request, 401 Unauthorized, 405 Method Not Allowed, etc).",
256 | "title":"Return the proper status code"
257 | }
258 | ]
259 | }
260 | ]
261 | },
262 | {
263 | "title_group": "CI & CD",
264 | "categories": [
265 | {
266 | "title": "CI & CD",
267 | "tasks": [
268 | {
269 | "priority": "medium",
270 | "explications": "Audit your design and implementation with unit/integration tests coverage.",
271 | "title":"Audit your design and implementation"
272 | },
273 | {
274 | "priority": "medium",
275 | "explications": "Use a code review process and disregard self-approval.",
276 | "title":"Use a code review process"
277 | },
278 | {
279 | "priority": "medium",
280 | "explications": "Ensure that all components of your services are statically scanned by AV software before push to production, including vendor libraries and other dependencies.",
281 | "title":"Services are statically scanned by AV software"
282 | },
283 | {
284 | "priority": "medium",
285 | "explications": "Design a rollback solution for deployments.",
286 | "title":"Design a rollback solution"
287 | }
288 | ]
289 | }
290 | ]
291 | }
292 | ]
293 | }
--------------------------------------------------------------------------------
/src/checklist/front-end.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Front-dev",
3 | "group_categories": [
4 | {
5 | "title_group": "Head",
6 | "categories": [
7 | {
8 | "title": "Meta tags",
9 | "tasks": [
10 | {
11 | "title": "Doctype",
12 | "links": [
13 | {"path":"https://www.w3.org/TR/html5/syntax.html#determining-the-character-encoding",
14 | "text":"Determining the character encoding - HTML5 W3C",
15 | "type": "link"}
16 | ],
17 | "explications":"The Doctype is HTML5 and is at the top of all your HTML pages.",
18 | "code":" ",
19 | "priority": "high"
20 | },
21 | {
22 | "title": "Charset",
23 | "explications":"The charset (UTF-8) is declared correctly.",
24 | "code":"\n",
25 | "priority": "high"
26 | },
27 | {
28 | "title": "X-UA-Compatible",
29 | "links": [
30 | {"path":"https://msdn.microsoft.com/en-us/library/jj676915(v=vs.85).aspx",
31 | "text":"Specifying legacy document modes (Internet Explorer)",
32 | "type": "link"}
33 | ],
34 | "explications":"The X-UA-Compatible meta tag is present.",
35 | "code":"\n",
36 | "priority": "medium"
37 | },
38 | {
39 | "title": "Viewport",
40 | "explications":"The viewport is declared correctly.",
41 | "code":"\n",
42 | "priority": "high"
43 | },
44 | {
45 | "title": "Title",
46 | "links": [
47 | {"path":"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title",
48 | "text":"Title - HTML - MDN",
49 | "type": "link"},
50 | {"path":"https://www.sistrix.com/serp-snippet-generator/",
51 | "text":"SERP Snippet Generator",
52 | "type": "tools"}
53 | ],
54 | "explications":"A title is used on all pages (SEO: Google calculates the pixel width of the characters used in the title, and it cuts off between 472 and 482 pixels. The average character limit would be around 55-characters).",
55 | "code":"\nPage Title less than 55 characters",
56 | "priority": "high"
57 | },
58 | {
59 | "title": "Description",
60 | "links": [
61 | {"path":"https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/The_head_metadata_in_HTML#Adding_an_author_and_description",
62 | "text":"Meta Description - HTML - MDN",
63 | "type": "link"}
64 | ],
65 | "explications":"A meta description is provided, it is unique and doesn't possess more than 150 characters.",
66 | "code":"\n",
67 | "priority": "high"
68 | },
69 | {
70 | "title": "Favicons",
71 | "links": [
72 | {"path":"https://www.favicon-generator.org/",
73 | "text":"Favicon Generator",
74 | "type": "tools"},
75 | {"path":"https://realfavicongenerator.net/",
76 | "text":"RealFaviconGenerator",
77 | "type": "tools"},
78 | {"path":"https://github.com/audreyr/favicon-cheat-sheet",
79 | "text":"Favicon Cheat Sheet",
80 | "type": "link"},
81 | {"path":"https://css-tricks.com/favicon-quiz/",
82 | "text":"Favicons, Touch Icons, Tile Icons, etc. Which Do You Need? - CSS Tricks",
83 | "type": "link"},
84 | {"path":"https://caniuse.com/#feat=link-icon-png",
85 | "text":"PNG favicons - caniuse",
86 | "type": "link"}
87 | ],
88 | "explications":"Each favicon has been created and displays correctly. If you have only a favicon.ico, put it at the root of your site. Normally you won't need to use any markup. However, it's still good practice to link to it using the example below. Today, PNG format is recommended over .ico format (dimensions: 32x32px).",
89 | "code":"\n\n\n",
90 | "priority": "medium"
91 | },
92 | {
93 | "title": "Apple Web App Meta",
94 | "links": [
95 | {"path":"https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html",
96 | "text":"Configuring Web Applications",
97 | "type": "link"},
98 | {"path":"https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html",
99 | "text":"Supported Meta Tags",
100 | "type": "link"}
101 | ],
102 | "explications":"Apple meta-tags are present.",
103 | "code":"\n\n\n\n\n\n\n\n",
104 | "priority": "low"
105 | },
106 | {
107 | "title": "Windows Tiles",
108 | "links": [
109 | {"path":"https://msdn.microsoft.com/en-us/library/dn320426(v=vs.85).aspx",
110 | "text":"Browser configuration schema reference",
111 | "type": "link"}
112 | ],
113 | "explications":"Windows tiles are present and linked.",
114 | "code":"\n",
115 | "priority": "low"
116 | },
117 | {
118 | "title": "Canonical",
119 | "links": [
120 | {"path":"https://support.google.com/webmasters/answer/139066?hl=en",
121 | "text":"Use canonical URLs - Search Console Help - Google Support",
122 | "type": "link"},
123 | {"path":"https://webmasters.googleblog.com/2013/04/5-common-mistakes-with-relcanonical.html",
124 | "text":"5 common mistakes with rel=canonical - Google Webmaster Blog",
125 | "type": "link"}
126 | ],
127 | "explications":"Use rel=\"canonical\" to avoid duplicate content.",
128 | "code":"\n",
129 | "priority": "low"
130 | }
131 | ]
132 | },{
133 | "title": "HTML tags",
134 | "tasks":[
135 | {
136 | "title": "Language attribute",
137 | "explications":"The lang attribute of your website is specified and related to the language of the current page.",
138 | "code":"",
139 | "priority": "high"
140 | },
141 | {
142 | "title": "Direction attribute",
143 | "links": [
144 | {"path":"https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir",
145 | "text":"dir - HTML - MDN",
146 | "type": "link"}
147 | ],
148 | "explications":" The direction of lecture is specified on the html tag (It can be used on another HTML tag).",
149 | "code":"",
150 | "priority": "medium"
151 | },
152 | {
153 | "title": "Alternate language",
154 | "links": [
155 | {"path":"The language tag of your website is specified and related to the language of the current page.",
156 | "text":"dir - HTML - MDN",
157 | "type": "link"}
158 | ],
159 | "explications":"The direction of lecture is specified on the html tag (It can be used on another HTML tag).",
160 | "code":"",
161 | "priority": "low"
162 | },
163 | {
164 | "title": "Conditional comments",
165 | "links": [
166 | {"path":"https://msdn.microsoft.com/en-us/library/ms537512(v=vs.85).aspx",
167 | "text":"About conditional comments (Internet Explorer) - MSDN - Microsoft",
168 | "type": "link"}
169 | ],
170 | "explications":"Conditional comments are present for IE if needed.",
171 | "priority": "low"
172 | },
173 | {
174 | "title": "RSS feed",
175 | "explications":"If your project is a blog or has articles, an RSS link was provided.",
176 | "priority": "low"
177 | },
178 | {
179 | "title": "CSS Critical",
180 | "links": [
181 | {"path":"https://github.com/addyosmani/critical",
182 | "text":"Critical by Addy Osmani on GitHub ",
183 | "type": "tools"}
184 | ],
185 | "explications":"The CSS critical (or \"above the fold\") collects all the CSS used to render the visible portion of the page. It is embedded before your principal CSS call and between in a single line (minified).",
186 | "priority": "medium"
187 | },
188 | {
189 | "title": "CSS order",
190 | "explications":"All CSS files are loaded before any JavaScript files in the . (Except the case where sometimes JS files are loaded asynchronously on top of your page).",
191 | "priority": "high"
192 | }
193 | ]
194 | },{
195 | "title": "Social meta",
196 | "tasks":[
197 | {
198 | "title": "Facebook Open Graph",
199 | "links": [
200 | {"path":"https://developers.facebook.com/docs/sharing/webmasters/",
201 | "text":"A Guide to Sharing for Webmasters",
202 | "type": "link"},
203 | {"path":"https://developers.facebook.com/docs/sharing/best-practices/",
204 | "text":"Best Practices - Sharing",
205 | "type": "link"},
206 | {"path":"https://developers.facebook.com/tools/debug/",
207 | "text":"Test your page with the Facebook OG testing",
208 | "type": "tools"}
209 | ],
210 | "explications":"All Facebook Open Graph (OG) are tested and no one is missing or with a false information. Images need to be at least 600 x 315 pixels, although 1200 x 630 pixels is recommended.",
211 | "code":"\n\n\n\n\n\n\n\n\n",
212 | "priority": "low"
213 | },
214 | {
215 | "title": "Twitter Card",
216 | "links": [
217 | {"path":"https://developer.twitter.com/en/docs/tweets/optimize-with-cards/guides/getting-started",
218 | "text":"Getting started with cards — Twitter Developers",
219 | "type": "link"},
220 | {"path":"https://cards-dev.twitter.com/validator",
221 | "text":"Test your page with the Twitter card validator",
222 | "type": "tools"}
223 | ],
224 | "code":"\n\n\n\n\n\n",
225 | "priority": "low"
226 | }
227 | ]
228 | }
229 | ]
230 | },
231 | {
232 | "title_group": "HTML",
233 | "categories": [
234 | {
235 | "title": "Best practices",
236 | "tasks": [
237 | {
238 | "title": "HTML5 Semantic Elements",
239 | "links": [
240 | {"path":"http://htmlreference.io/",
241 | "text":"HTML Reference",
242 | "type": "link"}
243 | ],
244 | "explications":"HTML5 Semantic Elements are used appropriately (header, section, footer, main...).",
245 | "priority": "high"
246 | },
247 | {
248 | "title": "Error pages",
249 | "explications":"Error 404 page and 5xx exist. Remember that the 5xx error pages need to have their CSS integrated (no external call on the current server).",
250 | "priority": "high"
251 | },
252 | {
253 | "title": "Noopener",
254 | "links": [
255 | {"path":"https://mathiasbynens.github.io/rel-noopener/",
256 | "text":"About rel=noopener",
257 | "type": "link"}
258 | ],
259 | "explications":"In case you are using external links with target=\"_blank\", your link should have a rel=\"noopener\" attribute to prevent tab nabbing. If you need to support older versions of Firefox, use rel=\"noopener noreferrer\".",
260 | "priority": "medium"
261 | },
262 | {
263 | "title": "Clean up comments",
264 | "explications":"Unnecessary code needs to be removed before sending the page to production.",
265 | "priority": "low"
266 | }
267 | ]
268 | },
269 | {
270 | "title": "HTML testings",
271 | "tasks": [
272 |
273 | {
274 | "title": "W3C compliant",
275 | "links": [
276 | {"path":"https://validator.w3.org/",
277 | "text":"W3C validator",
278 | "type": "tools"}
279 | ],
280 | "explications":"All pages need to be tested with the W3C validator to identify possible issues in the HTML code.",
281 | "priority": "high"
282 | },
283 | {
284 | "title": "HTML Lint",
285 | "links": [
286 | {"path":"https://dirtymarkup.com/",
287 | "text":"Dirty markup",
288 | "type": "tools"},
289 | {"path":"https://sonarwhal.com/",
290 | "text":"Sonar a linting tool for the web",
291 | "type": "tools"}
292 | ],
293 | "explications":"I use tools to help me analyze any issues I could have on my HTML code.",
294 | "priority": "high"
295 | },
296 | {
297 | "title": "Link checker",
298 | "links": [
299 | {"path":"https://validator.w3.org/checklink",
300 | "text":"W3C Link Checker",
301 | "type": "tools"}
302 | ],
303 | "explications":"There are no broken links in my page, verify that you don't have any 404 error.",
304 | "priority": "high"
305 | },
306 | {
307 | "title": "Adblockers test",
308 | "explications":"Your website shows your content correctly with adblockers enabled (You can provide a message encouraging people to disable their adblocker).",
309 | "priority": "medium"
310 | }
311 |
312 | ]
313 | }
314 | ]
315 | },
316 | {
317 | "title_group": "Webfonts",
318 | "categories": [
319 | {
320 | "title": "Webfont",
321 | "tasks": [
322 | {
323 | "title": "WOFF, WOFF2 and TTF are supported by all modern browsers.",
324 | "links": [
325 | {"path":"https://caniuse.com/#feat=woff",
326 | "text":"WOFF - Web Open Font Format - Caniuse.",
327 | "type": "link"},
328 | {"path":"https://caniuse.com/#feat=woff2",
329 | "text":"WOFF 2.0 - Web Open Font Format - Caniuse.",
330 | "type": "link"},
331 | {"path":"https://caniuse.com/#feat=ttf",
332 | "text":"TTF/OTF - TrueType and OpenType font support",
333 | "type": "link"},
334 | {"path":"https://css-tricks.com/snippets/css/using-font-face/",
335 | "text":"Using @font-face - CSS-Tricks",
336 | "type": "link"}
337 | ],
338 | "explications":"Webfont format",
339 | "priority": "high"
340 | },
341 | {
342 | "title": "Webfont size",
343 | "explications":"Webfont sizes don't exceed 2 MB (all variants included).",
344 | "priority": "high"
345 | },
346 | {
347 | "title": "Webfont loader",
348 | "links": [
349 | {"path":"https://github.com/typekit/webfontloader",
350 | "text":"Typekit Web Font Loader",
351 | "type": "tools"}
352 | ],
353 | "explications":"Control loading behavior with a webfont loader.",
354 | "priority": "low"
355 | }
356 | ]
357 | }
358 | ]
359 | },
360 | {
361 | "title_group": "CSS",
362 | "categories": [
363 | {
364 | "title": "CSS",
365 | "tasks": [
366 | {
367 | "title": "Responsive Web Design",
368 | "explications":"The website is using responsive web design.",
369 | "priority": "high"
370 | },
371 | {
372 | "title": "CSS Print",
373 | "explications":"A print stylesheet is provided and is correct on each page.",
374 | "priority": "medium"
375 | },
376 | {
377 | "title": "Preprocessors",
378 | "explications":"Your project is using a CSS preprocessor (e.g Sass, Less, Stylus).",
379 | "priority": "low"
380 | },
381 | {
382 | "title": "Unique ID",
383 | "explications":"If IDs are used, they are unique to a page.",
384 | "priority": "high"
385 | },
386 | {
387 | "title": "Reset CSS",
388 | "links": [
389 | {"path":"https://meyerweb.com/eric/tools/css/reset/",
390 | "text":"Reset.css",
391 | "type": "link"},
392 | {"path":"https://necolas.github.io/normalize.css/",
393 | "text":"Normalize.css",
394 | "type": "link"},
395 | {"path":"https://getbootstrap.com/docs/4.0/content/reboot/",
396 | "text":"Reboot",
397 | "type": "link"}
398 | ],
399 | "explications":"A CSS reset (reset, normalize or reboot) is used and up to date. (If you are using a CSS Framework like Bootstrap or Foundation, a Normalize is already included into it.)",
400 | "priority": "high"
401 | },
402 | {
403 | "title": "JS prefix",
404 | "code":"
\n\n
",
405 | "explications":"All classes (or id- used in JavaScript files) begin with js- and are not styled into the CSS files.",
406 | "priority": "low"
407 | },
408 | {
409 | "title": "embedded or inline CSS",
410 | "explications":"Avoid at all cost embedding CSS in