Skip to content

Commit

Permalink
docs: adiciona instruções de como subir a aplicação localmente
Browse files Browse the repository at this point in the history
  • Loading branch information
iagorrr committed Nov 18, 2024
1 parent 9da0e4a commit c88618b
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# 2024.2-T01-CD-MOJ

Repositório de projeto da disciplina de REQ-T1.

<p align="center">
Expand All @@ -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.
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/).

0 comments on commit c88618b

Please sign in to comment.