From fa73f9639f5570e4f1cda5477a3e5eb60d43319f Mon Sep 17 00:00:00 2001 From: Braydon Harris Date: Tue, 18 Jun 2024 19:12:48 -0600 Subject: [PATCH] fix: typos chore: update readme --- README.md | 17 +++++++++++++---- src/models/dto/response.dto.ts | 2 +- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f6d50ba..8afaaa0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ -# Playtak-api +# PlayTak-API ## Description ![Unit Tests](https://github.com/USTakAssociation/playtak-api/actions/workflows/ci.yml/badge.svg) -This is the Play Tak API projects which contains multiple endpoints for serivcing data to the Play Tak UI +This is the Play Tak API project which contains multiple endpoints for servicing data to the Play Tak UI + +## Requirements +- node v16.17.1 +- sqlite3 ## Installation @@ -52,7 +56,7 @@ Events Games History - /v1/games-history/ - /v1/games-history/{id} -- /v1/games-historoy/ptn/{id} +- /v1/games-history/ptn/{id} - /v1/hames-history/db Ratings @@ -61,6 +65,11 @@ Ratings ## TODO - create user auth endpoints and test +- dockerize app +- setup API key registration to track usage +- add automated versioning and setup release artifacts with github +- build out more robust deploy and rollback +- add health check endpoint ## Contributing @@ -81,7 +90,7 @@ Please read [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on our code of c We use [SemVer](http://semver.org/) for versioning. For the versions available, see the tags on this repository. ## Contributors -Play tak is only possible due to the excellent work of the following contributors: +PlayTak is only possible due to the excellent work of the following contributors: || :----:| diff --git a/src/models/dto/response.dto.ts b/src/models/dto/response.dto.ts index 1b3daa3..e59f0de 100644 --- a/src/models/dto/response.dto.ts +++ b/src/models/dto/response.dto.ts @@ -1,7 +1,7 @@ /* eslint-disable indent */ import { ApiProperty } from '@nestjs/swagger'; -export class DefaultReposeDto { +export class DefaultResponseDto { @ApiProperty() status: number;