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