diff --git a/docs/index.md b/docs/index.md index 6ec13fa5..f1ccc7b6 100644 --- 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 | \ No newline at end of file diff --git a/docs/info/backend.md b/docs/info/backend.md index 5e9c17ea..1978a24d 100644 --- a/docs/info/backend.md +++ b/docs/info/backend.md @@ -1,95 +1,114 @@ -# Como Subir o Projeto - +### Como subir o projeto Estas etapas são válidas para Linux OS e WSL. +#### Como subir o back-end: -## Como Subir o Backend +Primeiramente, interrompa qualquer processo que use o porto 8080, 3306 e 6379. Então atualize o seu sistema: + ``` + sudo apt-get update + ``` -1. **Atualização do Sistema:** + ``` + sudo apt-get upgrade + ``` - Primeiramente, interrompa qualquer processo que utilize as portas 8080, 3306 e 6379. Em seguida, atualize o sistema: +2. **Instalação de Dependências:** - ```bash - sudo apt-get update - sudo apt-get upgrade - ``` +- Instale o Python, Pip e os cabeçalhos do Python e MySQL: -2. **Instalação de Dependências:** + Python: + ``` + sudo apt-get install python3.11 + ``` - - Instale o Python 3.11, Pip e os cabeçalhos necessários: + Pip: + ``` + sudo apt-get install python3-pip + ``` - ```bash - sudo apt-get install python3.11 - sudo apt-get install python3-pip python3.11-dev default-libmysqlclient-dev build-essential pkg-config - ``` + Cabeçalhos: + ``` + sudo apt-get install python3.11-dev default-libmysqlclient-dev build-essential pkg-config + ``` - - Instale o `mysqlclient`: + mysqlclient: - ```bash - pip install mysqlclient - ``` + ``` + pip install mysqlclient + ``` -3. **Instalação do Virtualenv:** +- Instale o virtualenv para criar um ambiente virtual do projeto: - - Instale o `virtualenv` para gerenciar ambientes virtuais: + Virtualenv: + ``` + sudo pip3 install virtualenv + ``` - ```bash - sudo pip3 install virtualenv - ``` +Vá para dentro da pasta raiz `api`: -4. **Configuração do Ambiente Virtual:** +1. Cria o ambiente virtual e ative-o: - - Vá para o diretório raiz do projeto `api`: + Criar ambiente virtual: + ``` + virtualenv -p python3.11 venv + ``` + + Ativar ambiente: + ``` + source venv/bin/activate + ``` - ```bash - cd caminho/para/o/diretorio/api - ``` +3. Com o ambiente virtual ativado, instale as dependências: - - Crie e ative o ambiente virtual: + ``` + pip install -r requirements.txt + ``` - ```bash - virtualenv -p python3.11 venv - source venv/bin/activate - ``` +4. Com o docker iniciado, crie a imagem do banco de dados pela primeira vez: -5. **Instalação de Dependências do Projeto:** + ``` + docker-compose build + ``` - - Com o ambiente virtual ativado, instale as dependências listadas no arquivo `requirements.txt`: +6. Suba a imagem: - ```bash - pip install -r requirements.txt - ``` + ``` + docker-compose up + ``` -6. **Configuração do Banco de Dados com Docker:** +8. Ainda no diretório raiz `api`, aplique as migrações: - - Com o Docker iniciado, construa a imagem do banco de dados: + ``` + python manage.py makemigrations + ``` - ```bash - docker-compose build - ``` + ``` + python3 manage.py migrate + ``` -7. **Iniciar Docker:** +10. Inicie o servidor: - - Suba o contêiner do banco de dados: + ``` + python3 manage.py runserver + ``` - ```bash - docker-compose up - ``` +Pronto! O servidor está configurado e em execução com o banco de dados configurado. -8. **Aplicação de Migrações:** +#### Pela segunda vez - - Ainda no diretório raiz `api`, aplique as migrações ao banco de dados: +Garanta que não haja nenhum processo que use o porto `8080`, `3306` e `6379`. Por fim, com todas as dependências configuradas, basta: - ```bash - python manage.py makemigrations - python manage.py migrate - ``` +- Iniciar o Docker e o container `sigeie`; +- Baixar as atualizações (caso haja): -9. **Iniciar o Servidor:** +```sh +git pull +``` - - Finalmente, inicie o servidor Django: +- Atualizar as dependências, fazer as migrações e iniciar o servidor: - ```bash - python manage.py runserver - ``` +```sh +source venv/bin/activate && pip install -r requirements.txt && python manage.py makemigrations && python manage.py migrate && python manage.py runserver +``` -Pronto! O servidor está configurado e em execução com o banco de dados configurado. +Isso é tudo, pessoal. +``` \ No newline at end of file diff --git a/docs/info/frontend.md b/docs/info/frontend.md index b7f96c17..b27f741a 100644 --- 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. +``` \ No newline at end of file