Code Monkey home page Code Monkey logo

world-cup-api's Introduction

World Cup API

This is a not official REST API that provides information about the 2022 FIFA World Cup! It gathers information from public sources and scrap it in an organized way, making the implementation easier.

It's totally free, and open-source, so you can collaborate with us. See CONTRIBUTING

Documentation

We are working on a documentation file to guide you on the use of this API, check DOCUMENTATION.md

Roadmap

  • Create the database schema.
  • Create a initial scrapper that setup all games, teams and group informations.
  • Create an endpoint /matches that gives information about the next games
  • Create an endpoint /teams that gives information about all the teams that are participating in the cup.
  • Create an endpoint /groups that gives information about all the groups of the points stage.
  • Create a terraform infrastructure to deploy this project on AWS
  • Create a scrapper that get the score of the current match and the past matches, to consolidate the data.
  • Create a job that consolidates group points based on matches
  • Create a domain and setup a letsencrypt.org SSL certificate to handle HTTPs requests.
  • Create a redis cache that handle requests that didnt change to ensure that database handles the incoming traffic.
  • Create a rate limiter to avoid flooding on the api.
  • Write unit tests for the api.
  • Write a view with the instructions to use the API and host it on / route.
  • Integrate with swagger
  • Write a github action that test, build and deploy this application to AWS
  • Include queries search on the main find endpoints

world-cup-api's People

Contributors

liverday avatar liahsheep avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.