https://github.com/theduardomaciel/ichess
Uma aplicação web para membros e administradores do projeto de extensão IChess.
https://github.com/theduardomaciel/ichess
Last synced: about 1 month ago
JSON representation
Uma aplicação web para membros e administradores do projeto de extensão IChess.
- Host: GitHub
- URL: https://github.com/theduardomaciel/ichess
- Owner: theduardomaciel
- Created: 2024-02-11T04:47:09.000Z (about 1 year ago)
- Default Branch: development
- Last Pushed: 2024-04-13T03:45:38.000Z (about 1 year ago)
- Last Synced: 2024-04-14T02:48:19.091Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://ichess-web.vercel.app
- Size: 3.54 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
IChess - Web
## 💻 Projeto
Uma dashboard para o controle da frequência dos membros do projeto de extensão IChess.
#### 🧭 Disponível para Web
> [!NOTE]
> O design do frontend do projeto [está disponível no Figma](https://www.figma.com/file/DKXZoEFnCNbtVV6XGPXGv0/Design?type=design&node-id=0:1&mode=design&t=Fkxlh0xGwJ7xfDvd-1).
## ✨ Tecnologias
- `[Base]` Next.js
- `[Estilização]` TailwindCSS + Shadcn
- `[Banco de dados]` Neon (PostgreSQL)
- `[Hospedagem]` Vercel
> [!WARNING]
> O projeto ainda está em desenvolvimento, portanto, diversos aspectos estarão inacabados e/ou não funcionais à medida que a aplicação torna-se mais robusta.
## 🧠 Princípios
1. Estar funcional o quanto antes, para a utilização das atividades do IChess.
2. Ser o mais genérico possível, no bom sentido, em relação à possibilidade de reutilização das interfaces e sistemas para outros projetos de extensão, no futuro, com a alteração de poucos componentes.
## 🚧 Roadmap
- [x] Implementar o frontend de todas as páginas
- [x] Verificar a possibilidade da conversão do repositório em um monorepo
## 👣 Como iniciar o projeto
Antes mesmo de clonar o código do projeto, é necessário instalar algumas dependências globalmente. Recomendamos o uso do `pnpm` por sua disponibilidade em todas as principais plataformas (Windows, Linux e Mac) e sua velocidade quando comparado ao `npm` tradicional.
Caso o `pnpm` não esteja instalado, é possível [https://pnpm.io/installation](baixá-lo aqui).
1. Para o correto funcionamento da aplicação, instale as seguintes dependências:
```
pnpm install --global turbo dotenv-cli
```
2. Após instalar as dependências globais, clone o repositório e utilize `pnpm install` para instalar as dependências do projeto.
3. Com tudo instalado, basta acessar o projeto por meio de um editor de texto ou IDE de preferência, como o VSCode:
```
cd ichess
code .
```
> [!WARNING]
> Após a instalação das dependências, certifique-se de reiniciar tudo que possa estar carregando o projeto no momento, como o VSCode ou terminais.
4. Em seguida, adicione o arquivo `.env` com as variáveis de ambiente adequadas para todos os pacotes (`/packages`) e aplicações (`/apps`), com base nos arquivos de exemplo `.env.example`.
Esse passo é essencial para o correto funcionamento dos pacotes e aplicações do monorepo.
5. Para dar início ao servidor local de desenvolvimento, utilize `pnpm dev`
## 🎲 Dados
Para a migração de um novo esquema para o banco de dados, utilize `pnpm db:generate` para a criação do arquivo `.sql` com a migração, e em seguida `pnpm db:migrate` para enviar os dados para a rede.
Para a visualização do banco de dados, utilize `pnpm db:studio`
> [!WARNING]
> Execute esse comando sempre na raiz do projeto para evitar erros com variáveis de ambiente.
## 🧹 Limpeza de dependências
```bash
pnpm dlx rimraf --glob **/node_modules
```
## 📝 Licença
Este projeto utiliza a MIT License. Veja o arquivo de [LICENÇA](LICENSE) para mais detalhes.