Skip to content

Commit

Permalink
add infos de rodar o projeto no readme
Browse files Browse the repository at this point in the history
  • Loading branch information
luciano-freitas-melo committed Dec 12, 2024
1 parent f84c33e commit bc841f9
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,31 @@ A documentação do projeto está disponivel nesse [link](https://sbd1.github.io
3. Execute a documentação localmente com ```python -m mkdocs serve```
4. **Obs:** As suas alterações só ficaram disponíveis na versão online após o PR para o branch *docs* ser aceito
5. **Importante:** Nunca mexa no branch *gh-pages*

## 🎮 Como rodar o jogo

### Pré-requisitos

- **Sistema operacional**: Distribuição Linux (testado no Ubuntu 20.04)
- **Docker**: versão 27 ou maior. [link para instalação no Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
- **Docker Compose**: versão 2 ou maior. [link para instalação no Ubuntu](https://docs.docker.com/compose/install/linux/#install-using-the-repository)

### Comandos para rodar

Primeiramente, tenha certeza que a porta localhost 5432 esteja livre para ser utilizada.

Após isso, para subir o banco e iniciar o jogo, basta executar a linha de comando abaixo na pasta do projeto:

```
docker compose build && docker compose up -d
```

### Acessando o Banco de Dados

Para acessar o banco de dados, é possível utilizar o `psql`, que é um cliente em linha de comando que permite essa interação com bancos de dados do postgres. Para acessar usando o docker utiliza-se o seguinte comando:

```
docker compose exec -u postgres db psql DB
```

Assim, é possível utilizar queries SQL e comandos do próprio `psql` para visualizar e manipular os dados do banco.

0 comments on commit bc841f9

Please sign in to comment.