Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Davicamilo23 authored Feb 14, 2025
1 parent a4716d6 commit 629c3b2
Showing 1 changed file with 23 additions and 50 deletions.
73 changes: 23 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,11 @@ AcheiUnB é um projeto desenvolvido para facilitar a vida dos estudantes da Univ
- [👥 Equipe](#-equipe)
- [✨ Início](#-início)
- [📋 Pré-requisitos](#-pré-requisitos)
- [💻 Ambiente](#-ambiente)
- [📁 Dependências do Projeto](#-dependências-do-projeto)
- [💾 Execução](#-execução)
- [Observações do Docker](#observações-do-docker)
- [✅ Autenticação com o Microsoft OAuth](#-autenticação-com-o-microsoft-oauth)
- [📥 Atualização do Banco de Dados](#-atualização-do-banco-de-dados)
- [✅ Autenticação com o Microsoft MSAL](#-autenticação-com-o-microsoft-msal)
- [🖱️ Acesso aos Serviços](#️-acesso-aos-serviços)
- [📍 Migrations](#-migrations)
- [⚙️ Fluxo do Front-End](https://github.com/unb-mds/2024-2-AcheiUnB/edit/main/README.md#%EF%B8%8F-fluxo-do-front-end)
- [📚 Documentação](#-documentação)
- [📎 Extra](#-extra)
- [Story Map e Activity Flow](#story-map-e-activity-flow)
Expand Down Expand Up @@ -59,29 +56,6 @@ Para rodar o projeto, você precisa das seguintes ferramentas:

- **Docker** v27.2.0

### 💻 Ambiente

Para configurar o ambiente, rode o seguinte script:

```bash
make config
```

### 📁 Dependências do Projeto

Para instalar as dependências, siga os passos abaixo:

```bash
# Crie um ambiente virtual para Python
python3 -m venv api/env

# Ative o ambiente virtual
source api/env/bin/activate

# Instale os pacotes do Python e do Node
make install
```

### 💾 Execução

Para iniciar o projeto, use o comando:
Expand All @@ -103,7 +77,7 @@ docker compose up
#### Observações do Docker

- Para rodar o projeto em segundo plano:

```bash
docker compose up -d
```
Expand All @@ -120,47 +94,46 @@ docker compose up
docker compose down -v
```

### ✅ Autenticação com o Microsoft OAuth
### ✅ Autenticação com o Microsoft MSAL

Para ativar o login com Google, substitua `your_client_id` no arquivo `web/.env.local` pelo Client ID do seu projeto no Google Cloud:
Para ativar o login com a Microsoft, substitua Client ID e Client Secret no arquivo API/.env pelo Client ID do seu projeto pelo seu token da Azure:

1. Acesse o portal do [Azure Active Directory](https://portal.azure.com/).
2. Crie um aplicativo para o AcheiUnB.
3. Defina como tipo de aplicativo "Aplicativo Web" e adicione `http://localhost:8000` como origem autorizada e URI de redirecionamento.
4. Copie o Client ID e o Client Secret gerados. e substitua em `API/.env`.
3. Defina como tipo de aplicativo "Aplicativo Web" e adicione http://localhost:8000 como origem autorizada e URI de redirecionamento.
4. Copie o Client ID e o Client Secret gerados. e substitua em API/.env.

Após a configuração, o login estará habilitado.

### 📥 Atualização do Banco de Dados
### 🖱️ Acesso aos Serviços

Os dados são obtidos por meio de scraping do site da UnB e precisam ser atualizados periodicamente. Para atualizar, use:
| Serviço | URL |
|------------|--------------------------|
| Frontend | http://localhost:5173 |
| Backend | http://localhost:8000 |

```bash
make updatedb-all
```
### ⚙️ Fluxo do Front-End

ou, de forma equivalente:
Acesse a pasta do frontend:

```bash
docker exec django-api python3 ./manage.py updatedb -a
cd web
```

### 🖱️ Acesso aos Serviços

| Serviço | URL |
|------------|--------------------------|
| Frontend | http://localhost:5173 |
| Backend | http://localhost:8000 |
Instale as dependências do projeto utilizando o npm:

### 📍 Migrations
```bash
npm install
```

Sempre que alterar o modelo de dados, crie novas migrations com os comandos:
Para rodar o projeto em modo de desenvolvimento:

```bash
make makemigrations # Cria as migrations
make migrate # Executa as migrations
npm run dev
```

Isso iniciará o servidor de desenvolvimento na porta `5173`.

## 📚 Documentação

Acesse a documentação completa do projeto [aqui](https://unb-mds.github.io/2024-2-AcheiUnB/).
Expand Down

0 comments on commit 629c3b2

Please sign in to comment.