Skip to content

Latest commit

 

History

History
284 lines (209 loc) · 9.67 KB

README.md

File metadata and controls

284 lines (209 loc) · 9.67 KB
Raw

Versões do Django

SIGE IE

Fase

Release 1 ✔️ Ir para milestone da release 1

Release 2 ✔️ Ir para milestone da release 2

Release 3 (atual) Ir para milestone da release 3

Visão geral do produto

Sobre

Aplicativo web mobile desenvolvido para a Universidade de Brasília com objetivo de gerenciar as instalações elétricas e dar suporte ao retrofitting das instalações.

Posição

O SIGE IE é um sistema da Universidade de Brasília para o gerenciamento de instalações elétricas com o objetivo de facilitar o cadastro das informações de instalação elétrica para ajudar na reforma da parte elétrica dos prédios e salas. Ele permite a automatização da geração de relatórios das instalações elétricas de cada lugar e a centralização dessas informações para uso dos responsáveis pelas instalações. As pessoas devem usar o SIGE IE porque ele simplifica e agiliza o processo de gerenciamento, principalmente do retrofitting de instalações elétricas, garantindo maior eficiência e segurança.

Objetivos

Simplificar o cadastro e gerenciamento de informações de instalações elétricas e automatizar a geração de relatórios.

Tecnologias

Back-end

Nome Versão Uso Configuração
Python 3.11.8 Linguagem Site oficial do Python Ou veja na seção "Como subir o back-end"
Django 4.2 (LTS) Framework web Automática
Django REST framework 3.14 API REST Automática
Docker 25.0.4 Conteiner e imagem Site oficial do Docker
Redis 7.2 Banco de dados cache para sessão Automática via Docker
MySQL 8.1 Banco de dados Automática via Docker
Cabeçalhos do Python3 e do MySQL - Cabeçalhos de desenvolvimento e bibliotecas Site do Pypi com as configurações Ou veja na seção "Como subir o back-end"
Observação

Atualmente o Django REST Framework suporta as seguintes versões do Python e do Django:

Python 3.6 3.7 3.8 3.9 3.10 3.11
Django 3.0 3.1 3.2 4.0 4.1 4.2 (LTS)

Como a versão LTS mais recente do Django (2024) é a 4.2, escolhemos configurar o projeto usando Python 3.11.

Front-end mobile

Nome Versão Uso Configuração
Flutter 3.19.3 Framework frontend Site oficial do Flutter
Android Studio Iguana IDE para desenvolvimento Android com Android SDK Site oficial do Android Studio

Contribuidores

AlefMemTav Pedro Lucas Contribuidor
EngDann Danilo Contribuidor
kauan2872 Kauan Contribuidor
OscarDeBrito Oscar Contribuidor
ramires31 Ramires Contribuidor

Visão geral do projeto

Organização

Papel Atribuições Responsável Participantes
Cliente Validar as entregas Loana Loana, Alex
Desenvolvedor back-end Codificar o backend, configurar a infraestrutura Pedro Pedro, Kauan, Oscar
Desenvolvedor frontend Codificar o frontend, realizar integração com backend Danilo Danilo, Ramires, Pedro
UX design Projetar a interface do usuário, criar protótipos e realizar entrevistas com os clientes Danilo Danilo
Analista de requisitos Levantar requisitos, gerenciar a documentação, validar com cliente Oscar Oscar, Ramires, Pedro

Configuração do ambiente

Como subir o projeto

Estas etapas são válidas para Linux OS e WSL.

Como subir o back-end:

Pela primeira vez

Primeiramente, interrompa qualquer processo que use o porto 8080, 3306 e 6379. Então atualize o seu sistema:

sudo apt-get update

sudo apt-get upgrade

Em seguida, caso já não tenha instalado:

  • Instale o Python, Pip e os cabeçalhos do Python e MySQL:

    Python:

    sudo apt-get install python3.11

    Pip:

     sudo apt-get install python3-pip

    Cabeçalhos:

    sudo apt-get install python3.11-dev default-libmysqlclient-dev build-essential pkg-config

  • Instale o virtualenv para criar um ambiente virtual do projeto:

    Virtualenv:

    sudo pip3 install virtualenv

Vá para dentro da pasta raiz api:

  1. Cria o ambiente virtual e ative-o:

    Criar ambiente virtual:

    virtualenv -p python3.11 venv

    Ativar ambiente:

    source venv/bin/activate

  2. Com o ambiente virtual ativado, instale as dependências:

    pip install -r requirements.txt

  3. Inicie o Docker, depois vá para o diretório api e crie a imagem do banco de dados e da api pela primeira vez:

    docker-compose up --build

  4. Em outro terminal, retorne para o diretório raiz api e aplique as migrações:

    python manage.py makemigrations

    python manage.py migrate

Pronto, o servidor já está rodando com o banco de dados configurado.

Pela segunda vez

Garanta que não haja nenhum processo que use o porto 8080, 3306 e 6379. Por fim, com todas as dependências configuradas, basta:

  • Inicar o Docker e o container sigeie;

  • Baixar as atualizações (caso haja):

    git pull

  • Atualizar as dependências, fazer as migrações e iniciar o servidor:

 source venv/bin/activate && python manage.py makemigrations && python manage.py migrate

Isso é tudo, pessoal.

Como subir o front-end:

Antes de começar, verifique se o Flutter SDK está atualizado e compatível com o projeto. Siga as instruções específicas para sua plataforma (Windows, macOS, Linux) disponíveis na documentação oficial do Flutter.

Caso ainda não tenha feito, instale os seguintes requisitos em sua máquina:

  • Flutter SDK: Siga as instruções de instalação para a sua plataforma.

  • Android Studio ou Visual Studio Code:

    • Android Studio:

      sudo snap install android-studio --classic

    • Visual Studio Code:

      sudo snap install code --classic

    Para o VS Code, instale as extensões do Flutter e Dart disponíveis na aba de extensões do editor.

  • Emulador Android ou um dispositivo físico: Configure um emulador usando o AVD Manager do Android Studio ou configure seu dispositivo Android para depuração USB.

Com o ambiente preparado, siga os passos abaixo:

  1. Clone o Repositório do Front-end:

    git clone https://github.com/ResidenciaTICBrisa/T2G3-Sistema-Instalacao-Eletrica.git

  2. Abra o Projeto no Editor: Abra a pasta clonada no Android Studio ou no Visual Studio Code.

  3. Baixe as Dependências: Abra um terminal na pasta frontend/sige_ie e execute o comando:

    flutter pub get

  4. Execute o Projeto:

    • No Android Studio: Escolha um dispositivo ou emulador na barra de ferramentas e clique em 'Run'.
    • No Visual Studio Code: Selecione um dispositivo ou emulador na barra de status e pressione F5 ou utilize o comando flutter run na paleta de comandos.

Pronto, o Front end já está rodando e você pode utilizá-lo.

Contribuição

Como contribuir

  1. Faça um fork do repositório do projeto.

  2. Clone o fork na sua máquina:

    git clone https://github.com/{seu-usuario}/T2G3-Sistema-Instalacao-Eletrica.git

  3. Comente na issue que deseja contribuir ou crie uma issue nova.

  4. Entre no repositório clonado na sua máquina:

    cd T2G3-Sistema-Instalacao-Eletrica

  5. Após enviar suas contribuições para o fork do seu repositório, faça um pull request.

  6. Aguarde a revisão.

Documentação