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

Commit

Permalink
docs(how-to-readme): fix minor issues
Browse files Browse the repository at this point in the history
  • Loading branch information
thegm445 committed Oct 20, 2023
1 parent b799f9d commit 95cd240
Showing 1 changed file with 2 additions and 52 deletions.
54 changes: 2 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,12 @@ 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.

## Instalação

Para instalar o projeto, é necessário ter o Python 3.11.5 e o Poetry 1.6.1
instalados. Você pode ver o guia de instalação do projeto
[aqui](https://mds.kyomi.dev/pt/latest/installation.html), ou seguir as
instruções abaixo:


## Ambiente
### Ambiente

Recomendamos o uso de **distribuições baseadas em Debian** como ambiente de
desenvolvimento do projeto. No Windows, recomendamos o uso do [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10)

## Começando
### Começando

Você pode instalar o projeto com os seguintes comandos:

Expand Down Expand Up @@ -48,10 +40,6 @@ Por fim, rode o projeto com o Docker:
$ docker compose up # para rodar em segundo plano, adicione ' -d '
```

```bash
$ git config --global core.autocrlf false
```

Para rodar as migrações do banco de dados, você precisará criar um container
temporário que executará as migrações. Faça isso com o seguinte comando:

Expand All @@ -68,44 +56,6 @@ $ docker compose down -v
# Isto removerá os volumes do Docker, o que significa que os dados do banco de dados serão perdidos.
```

Para executar os testes do projeto, use o seguinte comando:

```bash
$ docker compose run --rm django python manage.py test
```

Se você precisar olhar os logs do servidor do Django, use o seguinte comando:

```bash
$ docker compose logs
```

## Para Desenvolvimento Local

### Git Hooks

```bash
$ poetry run pre-commit install \
--hook-type pre-commit \
--hook-type pre-push \
--hook-type commit-msg
```

### Django

Para criar um superusuário, a fim de se poder acessar o painel de administração
do Django, use o seguinte comando:

```bash
$ docker compose run --rm web python manage.py createsuperuser
```

E para criar migrações do banco de dados, use o seguinte comando:

```bash
$ docker compose run --rm web python manage.py makemigrations
```

## Links

- [Documentação](https://mds.kyomi.dev/pt/latest/)

0 comments on commit 95cd240

Please sign in to comment.