Instalação

Esta página descreve a instalação do projeto em Windows 11 e em sistemas Unix, como Ubuntu.

Pré-requisitos

Antes de executar o projeto, tenha instalado:

  • Python 3.11 ou 3.12;
  • Node.js 18 ou superior;
  • Docker com suporte a Compose;
  • Git.

1. Clonar o repositório

git clone <url-do-repositorio>
cd gestao-risco-ufsm-main

2. Criar o ambiente virtual

python -m venv .venv

3. Ativar o ambiente virtual

No Windows 11:

.\.venv\Scripts\Activate.ps1

No Ubuntu/Linux:

source .venv/bin/activate

4. Instalar dependências do backend

pip install -r requirements.txt
pip install "psycopg[binary]"

5. Variáveis de ambiente

Crie um arquivo .env a partir do modelo.

No Windows 11:

Copy-Item .env.example .env

No Ubuntu/Linux:

cp .env.example .env

Use os valores locais abaixo:

DATABASE_NAME=gestao_risco_ufsm
DATABASE_USER=postgres
DATABASE_PASSWORD=postgres
DATABASE_HOST=localhost
DATABASE_PORT=5433
DEBUG=True

6. Banco de dados

Suba o PostgreSQL com Docker Compose:

docker compose up -d

Se sua instalação ainda estiver no formato antigo:

docker-compose up -d

Depois, aplique as migrations:

python manage.py migrate

7. Usuários de teste opcionais

Para popular usuários vinculados a múltiplos setores:

python manage.py seed_usuarios_teste

Para redefinir a senha desses usuários:

python manage.py seed_usuarios_teste --reset-password

Senha padrão:

Teste@12345

8. Frontend

Instale as dependências do frontend:

cd src/frontend
npm install
cd ../..

9. Execução local

Inicie o backend:

python manage.py runserver

Inicie o frontend em outro terminal:

cd src/frontend
npm run dev

10. Validação

Execute os testes automatizados:

python -m pytest

Valide a documentação:

python -m mkdocs build