Api PlayTenis

Esta é uma api desenvolvida com as tecnologias para o backend de um aplicativo de controle de jogos e quadras de tenis.

Como funciona?

A api PlayTenis gerencia os dados que trafegam no aplicativo. Quadras, jogadores, modalidades de jogos, estatus dos jogos no momento, interdição de jogos e muito mais.

Juntando todas as partes

Para ter um funcionamento completo do projeto, você precisa também, baixar e executar a versão web e o aplicativo.

App PlayTenis PlayTenis Web

Tecnologias utilizadas

O projeto foi desenvolvido usando as linguagens e ferramentas abaixo.

Como baixar o projeto usando Docker

    # Clonar o repositório
    $ git clone https://github.com/NailsonCodens/playtenis

    # Entrar no diretório
    $ cd playtenis

    # Rodar Docker
    $ docker-compose up 

    #rodando as migrations do banco de dados
    $ yarn migrations

Como baixar o projeto localmente SEM Docker

    # Clonar o repositório
    $ git clone https://github.com/NailsonCodens/playtenis

    # Entrar no diretório
    $ cd playtenis

    # Instalar dependências
    $ yarn install

    #rodando as migrations do banco de dados
    $ yarn migrations

    # Iniciar projet
    $ yarn dev

Ngrok

Caso você precisa tornar esta api publica mesmo sem servidor, você pode usar um container do Ngrok para fazer um tunelamento da api para algum endereço gerado pelo Ngrok, que já está pronto para ser executado dentro do docker-compose.yml, bastando apenas descomentar as linhas necessárias:

Desconte este trecho do arquivo docker-compose.yml.

  #ngrok:
    #image: wernight/ngrok
    #volumes:
      #- ./ngrok.yml:/home/ngrok/.ngrok2/ngrok.yml
    #ports:
      #- "4040:4040"
    #command: ["ngrok", "http", "api_playtenis:3000"]

Acessando o ngrok para acessar o link tunelado

ATENÇÃO: 4040 é a porta que foi escolhida pro Ngrok no container, assim como a porta da própria api em localhost.

    $ https://localhost:4040

Funcionalidades

Coachs - Professores

• Cadastro
• Listagem
• Atualização
• Deleção

Courts - Quadras

• Cadastro
• Listagem
• Atualização
• Deleção

Modality - Modalidade

• Cadastro
• Listagem
• Atualização
• Deleção

Members - Membros associados

• Cadastro
• Listagem
• Atualização
• Deleção
• Buscar dependentes pelo associado

Dependents - Dependentes dos associados

• Cadastro
• Listagem
• Atualização
• Deleção
• Associação ao sócio

Games - Jogos

• Cadastro
• Finalizar um jogo
• Deletar um jogo
• Ver jogo atual pela quadra

Queue - Fila de espera

• Cadastro
• Alterar status quando a fila de espera for para jogo.
• Deletar a fila de espera
• Buscar fila de espera por jogadores
• Buscar fila de espera por id

Acessando o projeto:

    $ https://localhost:3000

Print Insominia

Print Documentação api Swagger

Desenvolvido por Nailson Israel