An open API service indexing awesome lists of open source software.

https://github.com/felipesantos92dev/futebol-brasileiro

Projeto abrangente para informações de times de futebol brasileiros. Next.js, TypeScript, PostgreSQL.
https://github.com/felipesantos92dev/futebol-brasileiro

brazilian football nextjs postgresql reactjs students tailwindcss typescript

Last synced: 5 months ago
JSON representation

Projeto abrangente para informações de times de futebol brasileiros. Next.js, TypeScript, PostgreSQL.

Awesome Lists containing this project

README

        

# Guia Times de Futebol Brasileiro

[![Capa do Projeto](https://i.imgur.com/2l6tnPy.jpg)](https://github.com/FelipeSantos92Dev/times-futebol-brasileiro)

Este é o repositório de um projeto abrangente dedicado aos times de futebol brasileiro. O projeto combina o desenvolvimento de uma API e um site público, oferecendo informações detalhadas sobre os times que competem nas diversas divisões do futebol brasileiro. O guia visa proporcionar uma experiência informativa e envolvente para os amantes do futebol, explorando os históricos, elencos, desempenho e muito mais de cada time.

## Visão Geral

O projeto possui as seguintes características principais:

- **Frontend em Next.js**: A interface do usuário foi desenvolvida utilizando Next.js, um framework React para renderização no lado do servidor, tornando-o altamente eficiente.

- **Estilização com Tailwind CSS**: O projeto utiliza o Tailwind CSS para a estilização, facilitando a criação de interfaces atraentes e responsivas.

- **Banco de Dados PostgreSQL**: As informações sobre os times de futebol brasileiro são armazenadas em um banco de dados PostgreSQL para consulta e análise.

- **Escrito em TypeScript**: O código é escrito em TypeScript para maior segurança e facilidade de manutenção.

## Pré-requisitos

Antes de executar o projeto, certifique-se de ter as seguintes ferramentas instaladas:

- Node.js
- PostgreSQL

## Instalação e Uso

Siga estas etapas para executar o projeto em sua máquina:

1. Clone o repositório

```sh
git clone https://github.com/FelipeSantos92Dev/futebol-brasileiro.git
```

2. Navegue para o diretório do projeto:

```sh
cd futebol-brasileiro
```

3. Instale as dependências:

```sh
yarn
```

4. Execute o projeto:

```sh
yarn dev
```

Acesse o aplicativo em seu navegador em http://localhost:3000.

## Configuração do Banco de Dados

Certifique-se de configurar o PostgreSQL e ajustar as configurações de conexão no arquivo de configuração.

```sh
# Exemplo de configuração do banco de dados
DATABASE_URL=postgres://seu_usuario:senha@localhost/seu_banco_de_dados
```

## Desenvolvimento de Novas Features

- [x] Criação de pasta na nuvem para armazenamento de imagens
- [x] Conexão com o banco de dados
- [x] Criação do model de times de futebol
- [x] Criação dos endpoints de times de futebol
- [ ] Criação do design do site utilizando o Figma
- [ ] Desenvolvimento de páginas de lista dos times de futebol
- [ ] Desenvolvimento de páginas de detalhes dos times de futebol
- [ ] Desenvolvimento da página inicial
- [ ] Adição de funcionalidade de pesquisa
- [ ] Implementação da autenticação de usuário
- [ ] Implementação de um painel de administração

Sinta-se à vontade para adicionar mais etapas de desenvolvimento de acordo com as necessidades do projeto.

## Contribuição

Se você deseja contribuir para este projeto, sinta-se à vontade para abrir issues e pull requests. Ficaremos felizes em receber contribuições!

## Licença

Este projeto é licenciado sob a MIT License - consulte o arquivo [LICENSE](LICENSE) para obter mais detalhes.

---

Desenvolvido por [Arthur Borges](https://github.com/Arthursenai), [Enrico Lona](https://github.com/Enrico070) e [Felipe Santos](https://github.com/FelipeSantos92Dev).