Skip to content

Commit 4a1fd43

Browse files
committed
chore: clean up readme
1 parent 6501001 commit 4a1fd43

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
# PlayTak
1+
# PlayTak
22

3-
This is the new monorepo for the PlayTak services
3+
This is the new monorepo for the PlayTak services
44

55
## Description
66

7-
![Unit Tests](https://github.com/USTakAssociation/playtak-api/actions/workflows/ci.yml/badge.svg)
8-
9-
107
This repo contains the api and Tak server for servicing data to the PlayTak UI client and games ui
118

129
## Requirements
10+
1311
- docker
1412
- nvm
1513
- node v20
1614
- sqlite3
1715

18-
## Setup
16+
## Setup
1917

2018
Run the following commands to setup the api for local development
2119

@@ -28,10 +26,10 @@ cd ..
2826

2927
setup the local databases
3028

31-
3229
```bash
3330
./scripts/development/create_databases.sh
3431
```
32+
3533
This creates the players and games sqlite dbs in the playtakdb folder
3634

3735
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".
@@ -51,7 +49,7 @@ docker compose up -d --build
5149

5250
## Test
5351

54-
You can run tests for each of the apps
52+
You can run tests for each of the apps:
5553

5654
```bash
5755
cd ./api
@@ -81,36 +79,38 @@ bru run test-suite --env local
8179
```
8280

8381
## TODO
82+
8483
- migrate to mariadb
8584
- create user auth endpoints and test
8685
- setup API key registration to track usage
8786
- add automated versioning and setup release artifacts with github
8887
- build out more robust deploy and rollback
8988
- java tests
9089

91-
9290
## Contributing
91+
9392
PlayTak is an Open Source Project. This means that:
9493

9594
> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit.
9695
9796
Please read [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
9897

9998
## Versioning
99+
100100
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the tags on this repository.
101101

102102
## Contributors
103+
103104
PlayTak is only possible due to the excellent work of the following contributors:
104105

105-
||
106-
:----:|
107-
|[chaitu](https://github.com/chaitu236)|
108-
|[Nohat](https://github.com/NoHatCoder)|
109-
|[Nitzel](https://github.com/nitzel)|
110-
|[InvaderB](https://github.com/invaderb)|
106+
| |
107+
| :-------------------------------------: |
108+
| [chaitu](https://github.com/chaitu236) |
109+
| [Nohat](https://github.com/NoHatCoder) |
110+
| [Nitzel](https://github.com/nitzel) |
111+
| [InvaderB](https://github.com/invaderb) |
111112

112113
See also the list of contributors who participated in this project.
113114

114115
License
115116
MIT License © USTA see LICENSE.md file
116-

0 commit comments

Comments
 (0)