Skip to content

Commit

Permalink
Adciciona página de subir aplicativo
Browse files Browse the repository at this point in the history
  • Loading branch information
OscarDeBrito committed Apr 2, 2024
1 parent fec0bff commit 4cbe34a
Show file tree
Hide file tree
Showing 4 changed files with 164 additions and 3 deletions.
94 changes: 94 additions & 0 deletions docs/info/backend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
### Como subir o projeto
Estas etapas são válidas para Linux OS e WSL.
#### Como subir o back-end:

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
```

mysqlclient:

```
pip install mysqlclient
```

- 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
```

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

```
pip install -r requirements.txt
```

4. Com o docker iniciado, crie a imagem do banco de dados pela primeira vez:

```
docker-compose build
```

6. Suba a imagem:

```
docker-compose up
```

8. Ainda no diretório raiz `api`, aplique as migrações:

```
python manage.py makemigrations
```

```
python3 manage.py migrate
```

10. Inicie o servidor:

```
python3 manage.py runserver
```

Pronto, o servidor já está rodando com o banco de dados configurado.
18 changes: 18 additions & 0 deletions docs/info/contribuir.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### 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
```

4. Comente na issue que deseja contribuir ou crie uma issue nova.
5. Entre no repositório clonado na sua máquina:

```
cd T2G3-Sistema-Instalacao-Eletrica
```

7. Após enviar suas contribuições para o fork do seu repositório, faça um pull request.
8. Aguarde a revisão.

48 changes: 48 additions & 0 deletions docs/info/frontend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#### 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](https://flutter.dev/docs/get-started/install).

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](https://developer.android.com/studio/debug/dev-options).

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 no editor 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.


7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ theme:

nav:
- Ínicio: index.md
- Fase do projeto:
- Release 1: release1.md

- Subir o projeto:
- Backend: info/backend.md
- Frontend: info/frontend.md
- Contribuições: info/contribuir.md

0 comments on commit 4cbe34a

Please sign in to comment.