Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/Serajfard/twitter-stream
Browse files Browse the repository at this point in the history
…into master
  • Loading branch information
Serajfard committed Jan 27, 2022
2 parents 9d353ec + 95274bd commit 6da6207
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ Includes two APIs for creating log and getting logs.

AppGateway is used to manage socket connection for real time streaming.

## Database

Sqlite is used as Database. There are two database files in data folder for development and testing. We can manage to use correct DB automatically based on environment and NestJS config file but in this sample code a manual config file is used.

## Installation

```bash
Expand All @@ -59,6 +63,8 @@ $ npm run start:prod

## Test

Seperate DB is used for testing purpose and it is managed properly.

```bash
# unit tests
$ npm run test
Expand All @@ -82,7 +88,7 @@ Swagger is used to generate API document automatically. Follow below steps to se
$ npm run start
```

2. Open this addres `http://localhost:3001/swagger/` in browser
2. Open following address `http://localhost:3001/swagger/` in browser

<img src="/assets/swagger.png" width="500">

Expand Down

0 comments on commit 6da6207

Please sign in to comment.