/sportscore-api

Application used to store and distribute information about sports.

Primary LanguageTypeScriptMIT LicenseMIT

Project logo

SportScore API

Bitbucket open issues GitHub forks GitHub stars GitHub forks


πŸ“ Table of Contents

🧐 About

The main idea of ​​the project is to facilitate the learning of other languages. We created a simple AI that will interact with you. Just ask questions that if she knows, she will answer.

We have some basic phrases from Portuguese and English only.

Prerequisites

What things you need to install the software and how to install them.

Installation

We chose to use docker and docker compose to develop this application. If you haven't installed it, you can find the installation steps here.

🎈 Usage

To see API Documentation, click here.

You just go up the stack and use it. Run:

$ docker-compose up -d

If you want to test it, just import the API collection into Postman.

You can changes params in compose.yml file.

⛏️ Built Using

✍️ Authors

πŸ“« Contribute to project

The project needs a lot of input for us to add more brokers providers, if you feel like helping or have some idea, please open an issue and help us.

  1. Fork the project.
  2. Create a branch: git checkout -b feature/<branch_name>.
  3. Commit your code changes: git commit -m '<message>'
  4. Push to your work branch: git push origin feature/<branch_name>
  5. Open a pull request.

Alternatively, see on GitHub docs How to create a pull request.

πŸ“ License

Distributed under the MIT License. See LICENSE for more information.