Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
omermujtaba18 authored Aug 28, 2024
1 parent ea16bf2 commit 78d9ef0
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
## Description [![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)
# 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)

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
$ npm install
$ cp .env.example .env
```

## Running the app
### Running the app

```bash
# development
Expand All @@ -28,7 +30,7 @@ $ npm run start:dev
$ npm run start:prod
```

## Test
### Test

```bash
# unit tests
Expand All @@ -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:

Expand All @@ -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
Expand Down

0 comments on commit 78d9ef0

Please sign in to comment.