2025.1-Algiz

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

Repositório do grupo Algiz

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🌱 EcoNet – Plataforma de Sustentabilidade Corporativa

> Conectando empresas por um futuro sustentável ♻️

![License](https://img.shields.io/badge/license-MIT-green)
![Contributors](https://img.shields.io/github/contributors/FGA0138-MDS-Ajax/2025.1-Algiz)
![Stars](https://img.shields.io/github/stars/FGA0138-MDS-Ajax/2025.1-Algiz)
![Last Commit](https://img.shields.io/github/last-commit/FGA0138-MDS-Ajax/2025.1-Algiz)
![Forks](https://img.shields.io/github/forks/FGA0138-MDS-Ajax/2025.1-Algiz)
![Views](https://komarev.com/ghpvc/?username=FGA0138-MDS-Ajax&label=Views)

---

## 📘 Visão Geral

**EcoNet** é uma aplicação web que promove a **economia circular**, conectando empresas com excesso de materiais a outras que podem reaproveitá-los. Nosso foco é transformar **descarte em oportunidade**, criando um ciclo produtivo e sustentável.

> 🌍 Alinhado ao ODS 12 da ONU – Produção e Consumo Responsáveis

---

**Tecnologias utilizadas para o desenvolvimento do projeto:**

![JavaScript](https://img.shields.io/badge/javascript-%23F7DF1E.svg?style=flat&logo=javascript&logoColor=black)
![Node.js](https://img.shields.io/badge/node.js-339933?style=flat&logo=nodedotjs&logoColor=white)
![React](https://img.shields.io/badge/react-%2361DAFB.svg?style=flat&logo=react&logoColor=black)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=flat&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=flat&logo=css3&logoColor=white)
![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=flat&logo=tailwind-css&logoColor=white)
![MySQL](https://img.shields.io/badge/mysql-%2300f.svg?style=flat&logo=mysql&logoColor=white)
![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=flat&logo=docker&logoColor=white)
![AdminJS](https://img.shields.io/badge/adminjs-%23D35848.svg?style=flat&logo=adminjs&logoColor=white) 
![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=flat&logo=github&logoColor=white)
![Docusaurus](https://img.shields.io/badge/docusaurus-%230A0A0A.svg?style=flat&logo=docusaurus&logoColor=white)

## 🔗 Documentos importantes

- [Contributing](./CONTRIBUTING.md) – Guia para colaboração  
- [Visão do Projeto](https://fga0138-mds-ajax.github.io/2025.1-Algiz/assets/files/visao-do-produto-e-do-projeto-algiz-2025.1-0b57c6470d086d33873d26cefe58f845.pdf) – Documento de visão do produto e do projeto
- [Arquitetura](https://fga0138-mds-ajax.github.io/2025.1-Algiz/assets/files/documento-de-arquitetura-algiz-2025.1-e46e1518abfe5013a2eaea3b6a66b73e.pdf) – Documento de arquitetura do projeto

---

## Contribuidores ✨



<table>
 <tbody>
 <tr>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/anawirthmann"><img src="https://avatars.githubusercontent.com/u/91133974?v=4?s=100" width="100px;" alt="Ana Beatriz C Wirthmann"/> Ana Beatriz C Wirthmann</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=anawirthmann" title="Documentation">📖</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/arthor13"><img src="https://avatars.githubusercontent.com/u/112632734?v=4?s=100" width="100px;" alt="Arthur de Lima Sobreira"/> Arthur de Lima Sobreira</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=arthor13" title="Code">💻</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/CauaNicolas"><img src="https://avatars.githubusercontent.com/u/79241219?v=4?s=100" width="100px;" alt="CauaNicolas"/> CauaNicolas</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=CauaNicolas" title="Code">💻</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/SDC-Diih"><img src="https://avatars.githubusercontent.com/u/48413982?v=4?s=100" width="100px;" alt="Diogo"/> Diogo</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=SDC-Diih" title="Code">💻</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/gabrielaugusto23"><img src="https://avatars.githubusercontent.com/u/103151217?v=4?s=100" width="100px;" alt="Gabriel Augusto"/> Gabriel Augusto</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=gabrielaugusto23" title="Code">💻</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=gabrielaugusto23" title="Documentation">📖</a> <a href="#design-gabrielaugusto23" title="Design">🎨</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=gabrielaugusto23" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/bielg7"><img src="https://avatars.githubusercontent.com/u/150948362?v=4?s=100" width="100px;" alt="Gabriel Pereira"/> Gabriel Pereira</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=bielg7" title="Documentation">📖</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="16.66%"><a href="https://lattes.cnpq.br/3832259830250068"><img src="https://avatars.githubusercontent.com/u/117182979?v=4?s=100" width="100px;" alt="João Victor Sousa"/> João Victor Sousa</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=Discicle" title="Code">💻</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/jopesmp"><img src="https://avatars.githubusercontent.com/u/113356974?v=4?s=100" width="100px;" alt="João Pedro Sampaio"/> João Pedro Sampaio</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=jopesmp" title="Code">💻</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/juliapat18"><img src="https://avatars.githubusercontent.com/u/204951019?v=4?s=100" width="100px;" alt="juliapat18"/> juliapat18</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=juliapat18" title="Code">💻</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=juliapat18" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/marianagonzaga0"><img src="https://avatars.githubusercontent.com/u/193804034?v=4?s=100" width="100px;" alt="marianagonzaga0"/> marianagonzaga0</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=marianagonzaga0" title="Documentation">📖</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=marianagonzaga0" title="Code">💻</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/rFaelxs"><img src="https://avatars.githubusercontent.com/u/176593068?v=4?s=100" width="100px;" alt="Rafael Siqueira Soares"/> Rafael Siqueira Soares</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=rFaelxs" title="Code">💻</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=rFaelxs" title="Tests">⚠️</a></td>
 <td align="center" valign="top" width="16.66%"><a href="https://github.com/TiagoSTdeLyra"><img src="https://avatars.githubusercontent.com/u/56367136?v=4?s=100" width="100px;" alt="TiagoSTdeLyra"/> TiagoSTdeLyra</a> <a href="https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz/commits?author=TiagoSTdeLyra" title="Code">💻</a></td>
 </tr>
 </tbody>
</table>

## 🔃 Como Rodar Localmente?
### Pré-requisitos

Antes de começar, recomendamos que você utilize o sistema operacional **Linux ou Linux WSL (Ubuntu)**, 
verifique também se você possui as seguintes ferramentas instaladas em sua máquina:

- [Node.js](https://nodejs.org/) (versão 20 ou superior)
- [npm](https://www.npmjs.com/) (gerenciador de pacotes do Node.js)
- [Docker](https://www.docker.com/)

## Passo a Passo:
## 1: Clonar o repositório

Clone este repositório em uma pasta da sua máquina local:

```bash
git clone https://github.com/FGA0138-MDS-Ajax/2025.1-Algiz.git
```

---
## 2: Primeira configuração

Copie `.env.example` para `.env` na pasta backend:

```bash
cd backend
cp .env.example .env
```
### Configuração de chaves opcionais  
O projeto possui funcionalidades que utilizam serviços externos opcionais. Você pode configurá-los editando o arquivo `.env`:

```bash
nano .env  # ou use seu editor preferido
```
### ⚙️ Funcionalidades Opcionais:
A aplicação suporta essas funcionalidades **somente se configuradas** no `.env` ou via CI/CD:

| Variável | Descrição |
|---------|-----------|
| `RESEND_API_KEY` | Ativa envio de e-mail via Resend |
| `RECAPTCHA_SECRET_KEY` | Ativa verificação reCAPTCHA |
| `DEV_RECOVERY_MODE`    | Modo desenvolvimento |

### 🧪 `DEV_RECOVERY_MODE`

Modo **desenvolvimento** que permite:
- Bypassar reCAPTCHA
- Exibir o código de recuperação direto no log e na resposta da API
- Use caso não consiga acesso as chaves secretas (`RESEND_API_KEY` e `RECAPTCHA_SECRET_KEY`)

**⚠️ Não ative em produção!**

Use no `.env`:
```env
DEV_PASSWORD_RECOVERY_MODE=true
```

---
## 3: Instalar dependências

Navegue até a pasta do projeto e execute os seguintes comandos para instalar as dependências do Node.js:

```bash
cd 2025.1-ALGIZ

cd backend
npm install

cd ../frontend
npm install

cd ../docs
npm install
```

---

## 4: Iniciar o servidor

### Backend (usando Docker)

Abra o terminal, vá até a pasta `backend` e execute:

```bash
cd backend
docker compose up --build
```

🔁 Resetar banco de dados:
Se você deseja apagar todo o banco, reconstruir os containers e aplicar os dados do zero (ideal para desenvolvimento), utilize o script abaixo:

```bash
./scripts/reset-db.sh
```
Este script irá:
- Derrubar os containers e volumes ```bash docker compose down -v ``` 
- Subir tudo novamente ```bash docker compose up ```

💡 Recomendado quando você quer garantir que está usando dados de teste atualizados.

⚙️ Rodar apenas migrations e seeders:
Primeiro: Certifique-se de que o backend esteja rodando com os containers Docker.
Se já está em execução (containers já estão rodando), você pode apenas aplicar as migrations e popular com os dados iniciais usando:
``` bash
./scripts/setup-db.sh
```
Esse script irá:
- Executar as migrations ```bash sequelize-cli db:migrate ```
- Rodar os seeders ```bash sequelize-cli db:seed:all ```

### Frontend

Em outro terminal, vá até a pasta `frontend`:

```bash
cd frontend
npm run dev
```

O frontend estará disponível em: [http://localhost:5173](http://localhost:5173)

### Documentação (Docusaurus)

Em outro terminal, vá até a pasta `docs`:

```bash
cd docs
npm run start
```

A documentação estará disponível em: [http://localhost:3000](http://localhost:3000)

---

## Observações

- O backend roda na porta `3001` via Docker.
- O frontend utiliza Vite.js e roda na porta `5173`.
- A documentação está disponível na porta `3000`.
- Certifique-se de que as portas não estejam em uso por outros serviços locais.
- Se o MySQL não conseguir iniciar:
  - Tente `docker compose down -v` e depois `docker compose up --build`
  - Verifique os registros com `docker compose logs db`

- Para se conectar ao contêiner do MySQL:
  ```bash
  docker exec -it backend-db-1 mysql -u root -pyourpassword
  ```

2025.1-Algiz

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

2025.1-Algiz

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README