@@ -14,6 +14,59 @@ This template provides a solid foundation for any new JavaScript project, ensuri
14
14
<img src="https://path-to-your/demo.gif" alt="Demonstration of pre-commit hooks" />
15
15
</p> -->
16
16
17
+ ---
18
+
19
+ ## Table of Contents <!-- omit in toc -->
20
+
21
+ - [ Quick Start] ( #quick-start )
22
+ - [ Why Choose ` js-quality-started ` ?] ( #why-choose-js-quality-started )
23
+ - [ What's Inside?] ( #whats-inside )
24
+ - [ Getting Started] ( #getting-started )
25
+ - [ Using as a Template] ( #using-as-a-template )
26
+ - [ Manual Setup] ( #manual-setup )
27
+ - [ Post-Template Setup] ( #post-template-setup )
28
+ - [ Available Scripts] ( #available-scripts )
29
+ - [ How It Works] ( #how-it-works )
30
+ - [ Pre-commit Hooks] ( #pre-commit-hooks )
31
+ - [ CI/CD Pipelines] ( #cicd-pipelines )
32
+ - [ Customization] ( #customization )
33
+ - [ Code Coverage] ( #code-coverage )
34
+ - [ Contributing] ( #contributing )
35
+ - [ License] ( #license )
36
+
37
+ ---
38
+
39
+ ## Quick Start
40
+
41
+ ``` bash
42
+ npx degit your-github-username/js-quality-started my-new-project
43
+ cd my-new-project
44
+ npm install
45
+ npm test
46
+ # Start building!
47
+ ```
48
+
49
+ ## Why Choose ` js-quality-started ` ?
50
+
51
+ Tired of repetitive setup, inconsistent code, and integration headaches? See how ` js-quality-started ` provides a superior foundation compared to starting from scratch or using basic boilerplates.
52
+
53
+ | Criteria | Minimal/Empty Repository | Basic Boilerplate | ` js-quality-started ` Template |
54
+ | :---------------------------- | :----------------------- | :------------------------------------- | :---------------------------- |
55
+ | ** Core Purpose** | Blank slate | Quick start, basic structure | Quality, consistency, efficiency |
56
+ | ** Linting (e.g., ESLint)** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured, opinionated |
57
+ | ** Formatting (e.g., Prettier)** | ❌ No | ⚙️ Manual setup required | ✅ Pre-configured |
58
+ | ** Testing Framework (e.g., Jest)** | ❌ No | ⚙️ Manual setup required | ✅ Pre-configured with coverage |
59
+ | ** Test Coverage Reporting** | ❌ No | ❌ No | ✅ Included |
60
+ | ** Build/Bundling Tool** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured (e.g., Babel) |
61
+ | ** Language Support** | JS Only | JS Only | JS (easily extensible to TS) |
62
+ | ** Documentation Gen. Tools** | ❌ No | ❌ No | ⚙️ Manual add/Configuring |
63
+ | ** CI/CD Configuration** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured GitHub Actions |
64
+ | ** Community Health Files** | ❌ No | ⚙️ Basic ` README.md ` | ✅ Comprehensive (` README ` , ` CONTRIBUTING ` , ` LICENSE ` , etc.) |
65
+ | ** Opinionation Level** | None | Low | High (for quality tools) |
66
+ | ** Initial Setup Time** | Very High | High | Very Low |
67
+ | ** Code Quality Assurance** | Manual | Limited / Manual | Automated & Proactive |
68
+ | ** Team Collaboration Aid** | Low | Moderate | High |
69
+
17
70
## What's Inside?
18
71
19
72
This template comes pre-configured with a suite of modern, industry-standard tools to ensure your project maintains high code quality.
0 commit comments