Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Commit

Permalink
chore(readme): improve README page
Browse files Browse the repository at this point in the history
  • Loading branch information
bitterteriyaki committed Oct 11, 2023
1 parent 0d9aadd commit 5179f98
Showing 1 changed file with 5 additions and 23 deletions.
28 changes: 5 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,9 @@
# 2023-2-Squad06

# Guia de instalação
Repositório contendo o código do projeto da disciplina de Métodos de
Desenvolvimento de Software. O projeto consiste em um juíz online para
programação competitiva.

## Resumo
## Links

Para a instalação e a operação corretas, deve se ter instalado na máquina:
- Python versão 3.11.5
- Poetry versão 1.6.1

Após verificar quanto aos requisitos acima, rode estes comandos:

- `poetry install`
- Se necessárias dependências de documentação, `poetry install --with docs`
- Para instalar Git Hooks:
```bash
poetry run pre-commit install \
--hook-type commit-msg \
--hook-type pre-commit \
--hook-type pre-push
```
- Gerar o arquivo config `poetry run ./bin/create-env`
- Para finalizar a instalação e conseguir visualizar a página:

- `docker compose build && docker compose up -d`
- `docker compose run django python manage.py migrate`
- `docker compose run django python manage.py createsuperuser`
- [Documentação](https://mds.kyomi.dev/pt/latest/)

0 comments on commit 5179f98

Please sign in to comment.