Skip to content

Commit f503355

Browse files
committed
docs: Update README.md
1 parent 7d0c642 commit f503355

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

README.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
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)
22

3-
nest-starter kit using [Nest](https://github.com/nestjs/nest) framework for any API development
3+
### Description
44

5-
### Features
5+
nest-starter kit using [Nest](https://github.com/nestjs/nest) framework for rapid api development
6+
7+
#### Features
68

79
- Authentication with local, jwt and google strategies.
810
- User management
911

10-
## Installation
12+
### Installation
1113

1214
```bash
1315
$ nvm use
1416
$ npm install
1517
$ cp .env.example .env
1618
```
1719

18-
## Running the app
20+
### Running the app
1921

2022
```bash
2123
# development
@@ -28,7 +30,7 @@ $ npm run start:dev
2830
$ npm run start:prod
2931
```
3032

31-
## Test
33+
### Test
3234

3335
```bash
3436
# unit tests
@@ -41,36 +43,35 @@ $ npm run test:e2e
4143
$ npm run test:cov
4244
```
4345

44-
## API Swagger Documentation
46+
### API Swagger Documentation
4547

4648
API documentation is available at http://localhost:3000/api-docs
4749

48-
## Commit Message Guide
50+
### Commit Message Guide
4951

50-
### Commit Message Format
52+
#### Commit Message Format
5153

5254
```
5355
<type>(<scope?>): <subject>
5456
```
55-
56-
#### Type
57+
##### Type
5758

5859
Must be one of the following:
5960

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

Comments
 (0)