From c88618b23dd2b5809f1a47d9fcf3c40d77c0473f Mon Sep 17 00:00:00 2001 From: iagorrr Date: Mon, 18 Nov 2024 20:06:48 -0300 Subject: [PATCH] =?UTF-8?q?docs:=20adiciona=20instru=C3=A7=C3=B5es=20de=20?= =?UTF-8?q?como=20subir=20a=20aplica=C3=A7=C3=A3o=20localmente?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5dfd011..1c237c2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # 2024.2-T01-CD-MOJ + Repositório de projeto da disciplina de REQ-T1.

@@ -7,4 +8,24 @@ Repositório de projeto da disciplina de REQ-T1. ## Introdução -O projeto CD-MOJ tem o objetivo de aprimorar a experiência na plataforma do MOJ, online judge do professor Bruno Ribas, da FGA. A plataforma possui vários pontos de melhoria na visão de requisitos funcionais e não funcionais. \ No newline at end of file +O projeto CD-MOJ tem o objetivo de aprimorar a experiência na plataforma do MOJ, online judge do professor Bruno Ribas, da FGA. A plataforma possui vários pontos de melhoria na visão de requisitos funcionais e não funcionais. + +## Subindo a documentação localmente + +Primeiramente é necessário possuir o [python](https://www.python.org/downloads/) instalado, então estando na raiz do projeto execute os seguintes comandos: + +```sh +# Criar um ambimente virtual do python +python3 -m venv .pyenv + +# "Entrar" no ambiente virtual +source ./.pyenv/bin/source + +# Instalar as bibliotecas necessárias +pip3 install -r requirements.txt + +# Subir a documentação +mkdocs serve +``` + +Com isso feito basta acessar o endereço fornecido (Ex: http://127.0.0.1:8000/).