Skip to content

Commit 6473bfc

Browse files
committed
chore: clean up api readme
1 parent 4a1fd43 commit 6473bfc

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

api/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
# PlayTak-API
1+
# PlayTak-API
22

33
## Description
44

5-
![Unit Tests](https://github.com/USTakAssociation/playtak-api/actions/workflows/ci.yml/badge.svg)
6-
75
The Play Tak API is a nodejs built using the nestjs project which contains multiple endpoints for servicing data to the Play Tak UI.
86

97
## Requirements
@@ -14,7 +12,7 @@ The Play Tak API is a nodejs built using the nestjs project which contains multi
1412
## Installation
1513

1614
```bash
17-
$ npm install
15+
npm install
1816
```
1917

2018
## Running the app
@@ -24,20 +22,22 @@ There are two options to run the project: manually, or with docker (recommended)
2422
Either way, you will need to create two databases, which can be done with the following bash script:
2523

2624
```bash
27-
sh ../script/development/create_databases.sh
25+
../scripts/development/create_databases.sh
2826
```
27+
2928
This creates the players and games sqlite databases.
3029

31-
Optionally, you can then use the script `scripts/development/add_user.sh` to add users to the local players database with a password of "password".
30+
Optionally, you can then use the script `../scripts/development/add_user.sh` to add users to the local players database with a password of "password".
3231

3332
```bash
34-
./scripts/development/add_user.sh mylocalacct ./players.db
35-
# See scripts/development/add_user.sh comments for more options.
33+
../scripts/development/add_user.sh username ../playtakdb/players.db
34+
# See ../scripts/development/add_user.sh comments for more options.
3635
```
3736

3837
### docker
3938

4039
In the root of the repo, run the following command:
40+
4141
```bash
4242
docker compose up -d --build
4343
```
@@ -77,14 +77,17 @@ https://api.playtak.com/api
7777
https://api.beta.playtak.com/api
7878

7979
Events
80+
8081
- /events
8182

8283
Games History
84+
8385
- /v1/games-history/
8486
- /v1/games-history/{id}
8587
- /v1/games-history/ptn/{id}
8688
- /v1/hames-history/db
8789

8890
Ratings
91+
8992
- /v1/ratings
9093
- /v1/ratings/{player_name}

0 commit comments

Comments
 (0)