Muda como subir o backend e frontend

ResidenciaTICBrisa · Jul 4, 2024 · e5c9e81 · e5c9e81
1 parent 8f5c461
commit e5c9e81
Show file tree

Hide file tree

Showing 3 changed files with 122 additions and 98 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -65,6 +65,6 @@ Como a versão LTS mais recente do Django (2024) é a 4.2, escolhemos configurar
 | --- | --- | --- | --- |
 | Cliente | Validar as entregas | Loana | Loana e Alex |
 | Desenvolvedor back-end | Codificar o backend, configurar a infraestrutura | Pedro | Pedro, Kauan e Oscar |
-| Desenvolvedor frontend | Codificar o frontend, realizar integração com backend | Danilo | Danilo, Ramires e Pedro |
+| Desenvolvedor frontend | Codificar o frontend, realizar integração com backend | Danilo | Danilo, Ramires, Pedro e Oscar |
 | 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 e Pedro |
diff --git a/docs/info/backend.md b/docs/info/backend.md
@@ -1,94 +1,110 @@
-### Como subir o projeto
-Estas etapas são válidas para Linux OS e WSL.
-#### Como subir o back-end:
+Claro! Aqui está o texto formatado em Markdown adequado para MkDocs em um único código contínuo:
 
-Primeiramente, interrompa qualquer processo que use o porto 8080, 3306 e 6379. Então atualize o seu sistema:
-  ```
-  sudo apt-get update
-  ```
+```markdown
+# Guia de Configuração do Back-end
 
-  ```
-  sudo apt-get upgrade
-  ```
+## 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:
+
+```sh
+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:
+#### Instale o Python, Pip e os cabeçalhos do Python e MySQL:
 
-  Python:
-  ```
-  sudo apt-get install python3.11
-  ```
+##### Python:
 
-  Pip:
-  ```
-   sudo apt-get install python3-pip
-  ```
+```sh
+sudo apt-get install python3.11
+```
 
-  Cabeçalhos:
-  ```
-  sudo apt-get install python3.11-dev default-libmysqlclient-dev build-essential pkg-config
-  ```
+##### Pip:
 
-   mysqlclient:
+```sh
+sudo apt-get install python3-pip
+```
 
-   ```
-   pip install mysqlclient
-   ```
+##### Cabeçalhos:
 
-- Instale o virtualenv para criar um ambiente virtual do projeto:
+```sh
+sudo apt-get install python3.11-dev default-libmysqlclient-dev build-essential pkg-config
+```
 
-    Virtualenv:
-    ```
-    sudo pip3 install virtualenv
-    ```
+#### Instale o virtualenv para criar um ambiente virtual do projeto:
 
-Vá para dentro da pasta raiz `api`:
+##### Virtualenv:
 
-1. Cria o ambiente virtual e ative-o:
+```sh
+sudo pip3 install virtualenv
+```
 
-    Criar ambiente virtual:
-     ```
-     virtualenv -p python3.11 venv
-     ``` 
-  
-    Ativar ambiente:
-     ```
-     source venv/bin/activate
-     ``` 
+#### Vá para dentro da pasta raiz `api`:
 
-3. Com o ambiente virtual ativado, instale as dependências:
+##### Cria o ambiente virtual e ative-o:
 
-   ```
-   pip install -r requirements.txt
-   ```
+###### Criar ambiente virtual:
 
-4. Com o docker iniciado, crie a imagem do banco de dados pela primeira vez:
+```sh
+virtualenv -p python3.11 venv
+```
 
-   ```
-   docker-compose build
-   ```
+###### Ativar ambiente:
 
-6. Suba a imagem:
+```sh
+source venv/bin/activate
+```
 
-   ```
-   docker-compose up
-   ```
+#### Com o ambiente virtual ativado, instale as dependências:
 
-8. Ainda no diretório raiz `api`, aplique as migrações:
+```sh
+pip install -r requirements.txt
+```
 
-   ```
-   python manage.py makemigrations
-   ```
+#### Inicie o Docker, depois vá para o diretório `api/sigeie` e crie a imagem do banco de dados pela primeira vez:
 
-   ```
-   python3 manage.py migrate
-   ```
+```sh
+docker-compose up -d
+```
 
-10. Inicie o servidor:
+#### Ainda no mesmo terminal, retorne para o diretório raiz `api` e aplique as migrações:
 
-    ```
-    python3 manage.py runserver
-    ```
+```sh
+python manage.py makemigrations
+python manage.py migrate
+```
+
+#### Inicie o servidor:
+
+```sh
+python manage.py runserver
+```
 
 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:
+
+- Iniciar o Docker e o container `sigeie`;
+- Baixar as atualizações (caso haja):
+
+```sh
+git pull
+```
+
+- Atualizar as dependências, fazer as migrações e iniciar o servidor:
+
+```sh
+source venv/bin/activate && pip install -r requirements.txt && python manage.py makemigrations && python manage.py migrate && python manage.py runserver
+```
+
+Isso é tudo, pessoal.
+```
diff --git a/docs/info/frontend.md b/docs/info/frontend.md
@@ -1,48 +1,56 @@
-#### Como Subir o Front-end:
+Claro! Aqui está o texto formatado em Markdown adequado para MkDocs em um único código contínuo:
 
-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](https://flutter.dev/docs/get-started/install).
+```markdown
+# Guia de Configuração do Front-end
+
+## 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.
+#### Flutter SDK:
+Siga as instruções de instalação para a sua plataforma.
+
+#### Android Studio ou Visual Studio Code:
+
+##### Android Studio:
+
+```sh
+sudo snap install android-studio --classic
+```
 
-- **Android Studio ou Visual Studio Code**:
+##### Visual Studio Code:
 
-  - Android Studio:
-    ```
-    sudo snap install android-studio --classic
-    ```
+```sh
+sudo snap install code --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.
+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](https://developer.android.com/studio/debug/dev-options). 
+#### 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
-    ```
+#### Clone o Repositório do Front-end:
 
-2. **Abra o Projeto no Editor**:
-    Abra a pasta clonada no Android Studio ou no Visual Studio Code.
+```sh
+git clone https://github.com/ResidenciaTICBrisa/T2G3-Sistema-Instalacao-Eletrica.git
+```
 
-3. **Baixe as Dependências**:
-    Abra um terminal no editor e execute o comando:
-    ```
-    flutter pub get
-    ```
+#### Abra o Projeto no Editor:
+Abra a pasta clonada no Android Studio ou no Visual Studio Code.
 
-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.
+#### Baixe as Dependências:
+Abra um terminal na pasta `frontend/sige_ie` e execute o comando:
 
-Pronto, o Front end já está rodando e você pode utilizá-lo.
+```sh
+flutter pub get
+```
 
+#### 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.
+```