From 78d9ef058d949d6e361eb79ea478877c0f5aafdd Mon Sep 17 00:00:00 2001 From: Omer Mujtaba <omer.mujtaba96@gmail.com> Date: Wed, 28 Aug 2024 21:11:11 +0300 Subject: [PATCH] docs: Update README.md --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index adbb491..0fc932e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ -## Description [](https://github.com/omermujtaba18/nest-api-starter/actions/workflows/ci.yaml) +# nest-api-starter [](https://github.com/omermujtaba18/nest-api-starter/actions/workflows/ci.yaml) -nest-starter kit using [Nest](https://github.com/nestjs/nest) framework for any API development +### Description -### Features +nest-starter kit using [Nest](https://github.com/nestjs/nest) framework for any rapid api development + +#### Features - Authentication with local, jwt and google strategies. - User management -## Installation +### Installation ```bash $ nvm use @@ -15,7 +17,7 @@ $ npm install $ cp .env.example .env ``` -## Running the app +### Running the app ```bash # development @@ -28,7 +30,7 @@ $ npm run start:dev $ npm run start:prod ``` -## Test +### Test ```bash # unit tests @@ -41,19 +43,18 @@ $ npm run test:e2e $ npm run test:cov ``` -## API Swagger Documentation +### API Swagger Documentation API documentation is available at http://localhost:3000/api-docs -## Commit Message Guide +### Commit Message Guide -### Commit Message Format +#### Commit Message Format ``` <type>(<scope?>): <subject> ``` - -#### Type +##### Type Must be one of the following: @@ -68,7 +69,7 @@ Must be one of the following: - **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) - **test**: Adding missing tests or correcting existing tests -#### Scope +##### Scope - **common**: for changes made on src/common directory - **config**: for changes made on src/config directory