| Home | Escopo | Gerência | Processo | Design | Configuração | Arquitetura | Banco de Dados |
|---|
Esta seção é dedicada sobre como configurar o ambiente e rodar o projeto localmente.
🛠 ️ Pré-requisitos Gerais
Antes de começar, certifique-se de que seu computador possui as ferramentas básicas instaladas.
- Git
- Node.js (v18 ou superior)
- Docker Desktop Recomendado para rodar o Backend e o Banco de Dados facilmente
🖥 ️ Frontend
O Frontend utiliza React e Vite.
1. Baixar e preparar a pasta
Abra seu terminal e execute os comandos abaixo, um por um:
# 1. Clona o repositório para sua máquina
git clone <url-do-repositorio-frontend>
# 2. Entra na pasta do projeto
cd bah-frontend
# 3. Instalar dependências
npm install
# 4. Rodar o projeto
npm run dev
# 5. Acessar
http://localhost:5173
Comandos úteis:
| Comando | O que faz? | Quando usar? |
|---|---|---|
npm run format |
Organiza o código | Antes de salvar/enviar seu código |
npm run lint |
Busca erros no código | Para checar se está tudo certo |
⚙ ️ Backend (API e Banco de Dados)
Opção A: Rodando com Docker (Recomendado)
Certifique-se que o Docker Desktop está aberto.
No terminal, dentro da pasta do backend:
# Sobe o banco de dados e a aplicação automaticamente
docker compose up --build
# Acessar a documentação (Swagger)
http://localhost:8000
# Acessar o gerenciador do banco de dados (Adminer)
http://localhost:8080
# Para o projeto
docker compose down
Opção B: Instalação Manual (Python Local)
# 1. Instalar gerenciador de pacotes
pip install pipenv
# 2. Instalar dependências e ativar ambiente
pipenv install --dev
# Entra no "modo desenvolvedor" (ambiente virtual)
pipenv shell
# Atenção Windows: Se der erro de pypiwin32, rode: pip install pypiwin32
# Cria as tabelas no banco de dados
pipenv run migrate
# Preenche com dados de teste iniciais
pipenv run seed
# 4. Rodar a aplicação
pipenv run app