1
- ## Description
1
+ # nest-api-starter [ ![ CI ] ( https://github.com/omermujtaba18/nest-api-starter/actions/workflows/ci.yaml/badge.svg )] ( https://github.com/omermujtaba18/nest-api-starter/actions/workflows/ci.yaml )
2
2
3
- nest-starter kit using [ Nest ] ( https://github.com/nestjs/nest ) framework for any API development
3
+ ### Description
4
4
5
- ### Features
5
+ nest-starter kit using [ Nest] ( https://github.com/nestjs/nest ) framework for rapid api development
6
+
7
+ #### Features
6
8
7
9
- Authentication with local, jwt and google strategies.
8
10
- User management
9
11
10
- ## Installation
12
+ ### Installation
11
13
12
14
``` bash
13
15
$ nvm use
14
16
$ npm install
15
17
$ cp .env.example .env
16
18
```
17
19
18
- ## Running the app
20
+ ### Running the app
19
21
20
22
``` bash
21
23
# development
@@ -28,7 +30,7 @@ $ npm run start:dev
28
30
$ npm run start:prod
29
31
```
30
32
31
- ## Test
33
+ ### Test
32
34
33
35
``` bash
34
36
# unit tests
@@ -41,36 +43,35 @@ $ npm run test:e2e
41
43
$ npm run test:cov
42
44
```
43
45
44
- ## API Swagger Documentation
46
+ ### API Swagger Documentation
45
47
46
48
API documentation is available at http://localhost:3000/api-docs
47
49
48
- ## Commit Message Guide
50
+ ### Commit Message Guide
49
51
50
- ### Commit Message Format
52
+ #### Commit Message Format
51
53
52
54
```
53
55
<type>(<scope?>): <subject>
54
56
```
55
-
56
- #### Type
57
+ ##### Type
57
58
58
59
Must be one of the following:
59
60
60
- - build: Changes that affect the build system or external dependencies (example scopes: node, npm)
61
- - chore: Updating tasks etc; no production code change
62
- - gh-actions: Changes to .github files and scripts (example scopes: ci, dependabot etc.)
63
- - docs: Documentation only changes
64
- - feat: A new feature
65
- - fix: A bug fix
66
- - perf: A code change that improves performance
67
- - refactor: A code change that neither fixes a bug nor adds a feature
68
- - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
69
- - test: Adding missing tests or correcting existing tests
70
-
71
- #### Scope
72
-
73
- - common: for changes made on src/common directory
74
- - config: for changes made on src/config directory
75
- - resources: for changes made on src/resources directory
76
- - lib: for changes made on root/libs directory
61
+ - ** build** : Changes that affect the build system or external dependencies (example scopes: node, npm)
62
+ - ** chore** : Updating tasks etc; no production code change
63
+ - ** gh-actions** : Changes to .github files and scripts (example scopes: ci, dependabot etc.)
64
+ - ** docs** : Documentation only changes
65
+ - ** feat** : A new feature
66
+ - ** fix** : A bug fix
67
+ - ** perf** : A code change that improves performance
68
+ - ** refactor** : A code change that neither fixes a bug nor adds a feature
69
+ - ** style** : Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
70
+ - ** test** : Adding missing tests or correcting existing tests
71
+
72
+ ##### Scope
73
+
74
+ - ** common** : for changes made on src/common directory
75
+ - ** config** : for changes made on src/config directory
76
+ - ** resources** : for changes made on src/resources directory
77
+ - ** lib** : for changes made on root/libs directory
0 commit comments