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
- PHP (8.2)
- Laravel Framework 10.12.0
- MySQL (5.7 ou superior)
- Composer (2.2 ou superior)
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/
git clone https://github.com/NeuronioAzul/cbc_comite_brasileiro_clubes.git
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
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:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=cbc
DB_USERNAME=cbc
DB_PASSWORD=cbc
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
Inserindo os dados no banco:
php artisan db:seed
Serão inseridos os dados na tabela de recursos com
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
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
Este projeto está licenciado sob a MIT License.