Skip to content

Commit 9929d68

Browse files
committed
docs: enhance Table of Contents for improved navigation and organization
1 parent 3238775 commit 9929d68

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,66 @@
22

33
NestJS boilerplate with TypeORM, GraphQL and PostgreSQL
44

5+
## Table of Contents
6+
7+
- [1. Open for Contribution](#1-open-for-contribution)
8+
9+
- [2. Getting Started](#2-getting-started)
10+
11+
- [2.1. Installation](#21-installation)
12+
- [2.2. Run](#22-run)
13+
14+
- [3. Docker](#3-docker)
15+
16+
- [3.1. Docker Compose Installation](#31-docker-compose-installation)
17+
- [3.2. Before Getting Started](#32-before-getting-started)
18+
- [3.3. Run](#33-run)
19+
- [3.4. Note](#34-note)
20+
- [3.5. Run Only Database (Local Dev)](#35-run-only-database-local-dev)
21+
22+
- [4. NestJS](#4-nestjs)
23+
24+
- [5. PostgreSQL Database](#5-postgresql-database)
25+
26+
- [6. TypeORM](#6-typeorm)
27+
28+
- [6.1. Migration Setup and Usage](#61-migration-setup-and-usage)
29+
30+
- [7. GraphQL](#7-graphql)
31+
32+
- [7.1. Protected Queries/Mutation By Role](#71-protected-queriesmutation-by-role)
33+
- [7.2. GraphQL Query To Select and Relations](#72-graphql-query-to-select-and-relations)
34+
- [7.3. Field-Level Permission](#73-field-level-permission)
35+
36+
- [8. Custom CRUD](#8-custom-crud)
37+
38+
- [9. Code generator](#9-code-generator)
39+
40+
- [10. Caching](#10-caching)
41+
42+
- [10.1. How To Use](#101-how-to-use)
43+
44+
- [11. TDD](#11-tdd)
45+
46+
- [11.1. Introduction](#111-introduction)
47+
- [11.2. Before Getting Started](#112-before-getting-started)
48+
- [11.3. Unit Test (with mock)](#113-unit-test-with-mock)
49+
- [11.4. Integration Test (with in-memory DB)](#114-integration-test-with-in-memory-db)
50+
- [11.5. End To End Test (with docker)](#115-end-to-end-test-with-docker)
51+
52+
- [12. CI](#12-ci)
53+
54+
- [12.1. Github Actions](#121-github-actions)
55+
- [12.2. Husky v9](#122-husky-v9)
56+
57+
- [13. SWC Compiler](#13-swc-compiler)
58+
59+
- [13.1. SWC + Jest error resolution](#131-swc--jest-error-resolution)
60+
61+
- [14. Todo](#14-todo)
62+
63+
- [15. License](#15-license)
64+
565
## 1. Open for Contribution
666

767
Totally open for any Pull Request, please feel free to contribute in any ways.

0 commit comments

Comments
 (0)