Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fga-eps-mds/2022-1-visualeasy-doc
Repositório destinado a documentação do projeto Visualeasy para a disciplina de EPS.
https://github.com/fga-eps-mds/2022-1-visualeasy-doc
hacktoberfest hacktoberfest2022 mkdocs
Last synced: 21 days ago
JSON representation
Repositório destinado a documentação do projeto Visualeasy para a disciplina de EPS.
- Host: GitHub
- URL: https://github.com/fga-eps-mds/2022-1-visualeasy-doc
- Owner: fga-eps-mds
- License: gpl-3.0
- Created: 2022-06-15T14:39:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-01T03:33:11.000Z (about 2 years ago)
- Last Synced: 2024-11-07T13:30:43.295Z (2 months ago)
- Topics: hacktoberfest, hacktoberfest2022, mkdocs
- Language: Jupyter Notebook
- Homepage: https://fga-eps-mds.github.io/2022-1-Visualeasy-Doc/
- Size: 24.3 MB
- Stars: 11
- Watchers: 8
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 2022.1-Visualeasy
## 🎮 Controle
[2022.1-Visualeasy-Controle](https://github.com/fga-eps-mds/2022-1-Visualeasy-Controle)[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy&metric=bugs)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy)## 📈 Frontend
[2022.1-Visualeasy-Frontend](https://github.com/fga-eps-mds/2022-1-Visualeasy-Frontend)[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy-Core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy-Core)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy-Core&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy-Core)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy-Core&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy-Core)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy-Core&metric=bugs)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-VisualVisualeasy-Coreeasy)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy-Core&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy-Core)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2022-1-Visualeasy-Core&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2022-1-Visualeasy-Core)## ℹ️ Sobre o projeto
O Visualeasy é uma aplicação Web que fornece uma visualização gráfica de métricas históricas de variáveis de produção.
O projeto é desenvolvido por alunos de gadruação em engenharia de Software da Universidade de Brasília - do Campus do Gama (FGA) - para a disciplina de Engenharia de Produto de Software (EPS).
A aplicação Visualeasy proporciona a visualização de dados de forma gráfica ao longo do tempo, para auxiliar na tomada de decisões.
### 👤 Equipe
Bruna Santos
Bruno Nunes
Damarcones Porto
Estevão Reis
Gabriel Batalha
Gustavo Duarte
Itallo Gravina
João Moura
Luis Fidelis
Marcos Vinícius
## 🔎 Informações Complementares
### ️ 🏗️ Para publicação no gh-pages
1 - Use o comando:
```pip install mkdocs```
2 - Para verificar se tudo deu certo, execute esse comando:
```mkdocs --version```
Deve estar na versão: version 1.2.2
3 - Após a instalação do mkdocs, é preciso instalar o nosso tema, utilizando o comando:
```pip install mkdocs-material```
```pip install mkdocs-awesome-pages-plugin```
4 - Para iniciar a página de documentação do projeto, entre no local onde a pasta do projeto foi clonada e execute o comando:
```mkdocs serve```
5 - Para realizar o deploy das suas mudanças nos documentos, verifique se não existe nenhuma divergência na main realize o push e depois utilize o comando dentro da branch main:
```mkdocs build```
e depois o comando
```mkdocs gh-deploy```