Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/midudev/kings-league-project

API y website de la Kings League Infojobs por temas didácticos
https://github.com/midudev/kings-league-project

kings-league kings-league-infojobs kingsleague

Last synced: 6 days ago
JSON representation

API y website de la Kings League Infojobs por temas didácticos

Host: GitHub
URL: https://github.com/midudev/kings-league-project
Owner: midudev
License: mit
Created: 2023-01-03T17:20:23.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-01-22T07:06:01.000Z (almost 2 years ago)
Last Synced: 2023-11-07T11:57:57.038Z (about 1 year ago)
Topics: kings-league, kings-league-infojobs, kingsleague
Language: JavaScript
Homepage: https://kingsleague.dev
Size: 47.5 MB
Stars: 1,534
Watchers: 17
Forks: 231
Open Issues: 15
Metadata Files:
- Readme: README.en.md
- Contributing: CONTRIBUTING.es.md
- License: LICENSE

Awesome Lists containing this project

README

        


👑 Kings League Infojobs Project ⚽️


[![Deploy API](https://github.com/midudev/kings-league-project/actions/workflows/deploy-api.yml/badge.svg?branch=main)](https://github.com/midudev/kings-league-project/actions/workflows/deploy-api.yml) [![Scrape Kings League Infojobs Website](https://github.com/midudev/kings-league-project/actions/workflows/scrape-kings-league-web.yml/badge.svg?branch=main)](https://github.com/midudev/kings-league-project/actions/workflows/scrape-kings-league-web.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)



API | WEB





![Mockup API Web](assets/static/ui-mockup-web-api.png)

  Table of contents

  


    

      Project description

    

    

      Technologies used

    

    API

    Social networks

		Lighthouse

		About Author

  


[![Spanish](https://img.shields.io/badge/language-Spanish-blue.svg)](README.md)

[![kings league project](https://jordinodejs.vercel.app/api/pin/?username=midudev&repo=kings-league-project&theme=calm&bg_color=ff7b25&title_color=000000&icon_color=d64161&border_color=d64161&text_color=eeeee4)](https://github.com/midudev/kings-league-project)

## Project Description

This project aims to create an API and web page for the [Kings League Infojobs](https://kingsleague.pro) for educational purposes.

The API provides access to data for teams, presidents, coaches, goal scorers, and assistants in the Kings League, and the web page offers information on the teams, results, and rankings in the league.

### Technologies Used

To retrieve the data for the API, we use *Web Scraping*, [Node.js](https://nodejs.org/en/), [Hono](https://honojs.dev/), and the API hosting service [Cloudflare Workers](https://workers.cloudflare.com/) for building and deployment.

The web page is developed using the [Astro](https://astro.build/) framework and we use the [CSS Tailwind](https://tailwindcss.com/) framework to style the user interface. We have also used the [Cherrio](https://github.com/cheeriojs/cheerio) library to perform *Web Scraping* and obtain data from the **Kings League Infojobs**.

To test and validate the functionality of the application, we have used the [Vitest](https://vitest.dev/) testing library.

If you would like to help us, please take a moment to read the [CONTRIBUTING.md](https://github.com/midudev/kings-league-project/blob/main/CONTRIBUTING.md) file. You will find useful information there on how to effectively contribute and follow our style guides. We hope you enjoy collaborating with us!

## API

Address: https://api.kingsleague.dev/

The available endpoints are:

 - GET `/leaderboard`: Returns the Kings League ranking.

 - GET `/teams`: Returns all the teams in the Kings League.

 - GET `/teams/:id`: Returns a Kings League team.

 - GET `/teams/:id/player-12`: Returns a player 12 from a Kings League team.

 - GET `/teams/:id/players/:playerId`: Returns a player from a Kings League team.

 - GET `/presidents`: Returns all Kings League presidents.

 - GET `/presidents/:id`: Returns a president of a Kings League team.

 - GET `/coaches`: Returns all the coaches in the Kings League.

 - GET `/coaches/:teamId`: Returns the coach of a Kings League team.

 - GET `/top-scorers`: Returns the top scorers in the Kings League.

 - GET `/top-scorers/:rank`: Returns the top scorer according to their position in the Kings League ranking.

 - GET `/top-assists`: Returns the top assisters in the Kings League.

 - GET `/top-assists/:rank`: Returns the top assist according to their position in the Kings League ranking.

 - GET `/mvp`: Returns the Kings League MVPs.

 - GET `/schedule`: Returns the Kings League match schedule and the result of the matches played.

 - GET `/players-12`: Returns the 12 players of the Kings League.

## Social Networks

Follow us on our Twitch channel to see how we are progressing in the development of the project or follow us on YouTube for more content about full-stack development!

- [Twitch](https://twitch.tv/midudev)

- [YouTube](https://www.youtube.com/c/midudev)

You can also join our community on [Discord](https://discord.gg/midudev)

## LightHouse

[![Lighthouse Performance Badge](./test_results/lighthouse_performance.svg)](https://github.com/midudev/kings-league-project)

[![Lighthouse Accessibility Badge](./test_results/lighthouse_accessibility.svg)](https://github.com/midudev/kings-league-project)

[![Lighthouse Best Practices Badge](./test_results/lighthouse_best-practices.svg)](https://github.com/midudev/kings-league-project)

[![Lighthouse SEO Badge](./test_results/lighthouse_seo.svg)](https://github.com/midudev/kings-league-project)

## About Author