Projeto 2023.2-Grupo03

Sobre Nós

Somos o Grupo 3 da disciplina de Requisitos de Software, ministrada pelo Professor André Barros. Este espaço serve como um repositório central para todos os artefatos desenvolvidos por nossa equipe ao longo da matéria. Aqui, você encontrará uma variedade de recursos, desde documentação técnica até atas de nossas reuniões de desenvolvimento.

Equipe

Caio Braga

Caio Lelis

Doan Filho

Gabriel Barbosa

Guilherme Basilio

Joel Soares

Miguel Matos

Instalação

Pré-requisitos

• Certifique-se de que você tem Python instalado em sua máquina. Se não tiver, você pode baixá-lo aqui.
• Você também precisará do gerenciador de pacotes Python pip. Ele geralmente é instalado junto com o Python.

Instalar MkDocs

1. Abra o terminal e execute o seguinte comando para instalar o MkDocs.

   pip install mkdocs

Instalar MkDocs Material

1. Abra o terminal e execute o seguinte comando para instalar o MkDocs Material.

   pip install mkdocs material
   

Execução

Construir o Projeto

1. Utilize o comando abaixo para construir os arquivos estáticos do projeto.

   mkdocs build

   Este comando irá gerar uma pasta site contendo todos os arquivos HTML, CSS e outros necessários para a visualização da documentação.

Servir o Projeto Localmente

1. Execute o seguinte comando para iniciar um servidor local.

   mkdocs serve

   Este comando inicia um servidor web local para que você possa visualizar a documentação em seu navegador. Normalmente, a URL será http://127.0.0.1:8000/.