Skip to content

Commit

Permalink
fix: typos
Browse files Browse the repository at this point in the history
chore: update readme
  • Loading branch information
invaderb committed Jun 19, 2024
1 parent fc03290 commit fa73f96
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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:

||
:----:|
Expand Down
2 changes: 1 addition & 1 deletion src/models/dto/response.dto.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/* eslint-disable indent */
import { ApiProperty } from '@nestjs/swagger';

export class DefaultReposeDto {
export class DefaultResponseDto {
@ApiProperty()
status: number;

Expand Down

0 comments on commit fa73f96

Please sign in to comment.