README.md

Bundesliga

Client API made with TypeScript.

Key Features • How To Use • Documentation

Key Features

• Football-data API
• Unit tests
• Functional test
• Data Sanitization
• Performance calculation for the first and last place in the Bundesliga season 2023/24

How To Use

You must obtain the authentication token by creating an account on football-data API.

After that, you must update the values ​​of the config/default.json and config/test.json.

To local run:

yarn install && yarn start:local

You can run tests with:

yarn test:unit

yarn test:functional

Documentation

GET - /standings

Response:

[
	{
		"position": 1,
		"team": {
			"name": "Bayer 04 Leverkusen",
			"crest": "https://crests.football-data.org/3.png"
		},
		"playedGames": 34,
		"won": 28,
		"draw": 6,
		"lost": 0,
		"points": 90,
		"performance": 88.24
	},
	{
		"position": 18,
		"team": {
			"name": "SV Darmstadt 98",
			"crest": "https://crests.football-data.org/55.png"
		},
		"playedGames": 34,
		"won": 3,
		"draw": 8,
		"lost": 23,
		"points": 17,
		"performance": 16.67
	}
]