NeuronioAzul / cbc_comite_brasileiro_clubes

Gerenciamento de Recursos Financeiros de Clubes - API

Índice

• Sobre
• Tecnologias utilizadas
• Configuração do ambiente
  • Clone o repositório:
  • Dependências
  • Altere o arquivo .env
  • Migrações
  • Carga de dados
  • Servidor
• Uso da Api
  • Documentação

Sobre

Esta é uma API REST desenvolvida como parte de um teste técnico para o Comitê Brasileiro de Clubes.

A API permite o gerenciamento de recursos financeiros de clubes, incluindo:

• listagem de clubes;
• cadastro de clubes;
• consumo de recursos.

Para mais informações sobre o teste acesse: 📕 Arquivo com o teste pdf

Tecnologias utilizadas

• PHP (8.2)
• Laravel Framework 10.12.0
• MySQL (5.7 ou superior)
• Composer (2.2 ou superior)

Configuração do ambiente

Certifique-se de ter o PHP e o MySQL instalados em seu ambiente de desenvolvimento.

Caso ainda não tenha, você pode baixar o WAMPP em : https://www.wampserver.com/en/

1. Clone o repositório:

git clone https://github.com/NeuronioAzul/cbc_comite_brasileiro_clubes.git

2. Dependências

Instale as dependências do projeto via Composer (2.2 ou superior)

Para download da versão mais nova do composer acesse: https://getcomposer.org/download/

composer install

3. Altere o arquivo .env

Na raiz do projeto e defina as configurações de banco de dados.

Configure as variáveis de ambiente relacionadas ao banco de dados, como no exemplo abaixo:

.env

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=cbc
DB_USERNAME=cbc
DB_PASSWORD=cbc

4. Migrações

Execute as migrações para criar as tabelas no banco de dados:

php artisan migrate

Para recriar novamente as tabelas execute:

php artisan migrate:fresh

5. Carga de dados

Inserindo os dados no banco:

php artisan db:seed

Serão inseridos os dados na tabela de recursos com

6. Servidor

Inicie o servidor de desenvolvimento:

Abra o terminal na pasta do projeto e execute o comando abaixo:

Mantenha o terminal aberto executando o servidor

php artisan serve

Uso da API

Acesse a API em http://localhost:8000/api.

A API possui as seguintes funcionalidades:

• Listar todos os clubes: GET /api/clubes
• Cadastrar um clube: POST /api/clubes
• Consumir recursos: POST /api/consume

Consulte a documentação da API para obter detalhes sobre a estrutura dos dados e os parâmetros esperados em cada requisição.

• 📚 Documentação da Api: Acesse a Documentação

Licença

Este projeto está licenciado sob a MIT License.