Sistema de Gestão Escolar (EduManager)

Equipe

Os desenvolvedores integrantes desse projeto são:

• EDGAR DE SOUZA DIAS
• ISAAC LEVI LIRA DE OLIVEIRA
• JOÃO EMANUEL MENDONÇA APÓSTOLO
• JOSÉ MATHEUS RIBEIRO DOS SANTOS
• MARIA EDUARDA PIRES POSSARI DOS SANTOS
• RAFAEL LIMA DANTAS
• ULISSES DE JESUS CAVALCANTE

Instruções para desenvolvedores

Antes de inciar a instalação, certifique-se de ter o Node.js e o Python nas versões mais recentes instalados. Caso ainda não tenha instalado, abaixo estão os links para download: https://www.python.org/downloads/ https://nodejs.org/pt/download Em seguida, basta clonar o repositório com git clone e seguir os passos seguintes.

Instalação do Backend

Para instalar todas as dependências do servidor, navegue até a pasta server, a partir do diretório raíz do projeto,com o comando no terminal:

cd server

Após isso, exclua a pasta venv já existente para evitar conflito de arquivos e crie um ambiente virtual:

python -m venv venv

Ative o ambiente virtual (Windows):

venv\Scripts\activate

Depois, instale todas as dependências com o comando:

pip install -r requirements.txt

O backend utiliza variáveis de ambiente para armazenar informações sensíveis ou específicas do ambiente. Crie um arquivo .env na pasta server com o seguinte conteúdo:

# Variáveis de ambiente para o banco de dados
DB_USER=
DB_PASSWORD=
DB_HOST=localhost
DB_PORT=5432
DB_NAME=
SECRET_KEY=
DEBUG=True

# Variáveis de ambiente para o banco de dados para a realização dos testes
TEST_DB_USER=
TEST_DB_PASSWORD=
TEST_DB_HOST=localhost
TEST_DB_PORT=5432
TEST_DB_NAME=

Observação: Certifique-se de preencher os valores pelas configurações adequadas ao seu ambiente.

Para iniciar o servidor Flask, execute o seguinte comando:

python run.py

Por padrão, o servidor estará disponível em http://localhost:5000.

Instalação do Frontend

Para instalar todas as dependências do cliente, navegue até a pasta client, a partir do diretório raíz do projeto, com o comando no terminal:

cd client

Para instalar todas as dependências do projeto node.js, execute o comando:

npm install

Para iniciar o servidor de desenvolvimento do React.js, execute o seguinte comando:

npm run dev

Por padrão, o frontend estará disponível em http://localhost:5173.

Testes do Backend

Para testar todos os componentes do backend, navegue até a pasta server, a partir do diretório raíz do projeto, com o comando no terminal:

cd server

Ative o ambiente virtual (Windows):

venv\Scripts\activate

Para iniciar os testes do backend, execute o comando:

pytest

Testes dos Frontend

Para testar todos os componentes do frontend, navegue até a pasta client, a partir do diretório raíz do projeto, com o comando no terminal:

cd client

Para iniciar os testes do frontend, execute o comando:

npm test