Skip to content

Commit c6f0dc5

Browse files
committed
docs: improve README
- list only local setup requirements - remove redundant verification guide - added .nvmrc file
1 parent a871d2c commit c6f0dc5

File tree

3 files changed

+5
-50
lines changed

3 files changed

+5
-50
lines changed

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
12.18.0

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Topcoder Bookings API
22

3-
## Dependencies
3+
## Requirements
44

5-
- nodejs https://nodejs.org/en/ (v12+)
6-
- PostgreSQL
7-
- ElasticSearch (7.x)
8-
- Docker
9-
- Docker-Compose
5+
- [Node.js](https://nodejs.org/en/) v12+
6+
- [Docker](https://www.docker.com/)
7+
- [Docker-Compose](https://docs.docker.com/compose/install/)
108

119
### Steps to run locally
1210

@@ -204,7 +202,3 @@ The following parameters can be set in the config file or via env variables:
204202
205203
- Run `npm run test` to execute unit tests
206204
- Run `npm run cov` to execute unit tests and generate coverage report.
207-
208-
## Verification
209-
210-
Refer to the verification document [Verification.md](Verification.md)

Verification.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)