From bc841f932f0994eef8b52fadd5f7db994ad102b8 Mon Sep 17 00:00:00 2001 From: luciano-freitas-melo <202016847@aluno.unb.br> Date: Thu, 12 Dec 2024 11:09:20 -0300 Subject: [PATCH] add infos de rodar o projeto no readme --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 2e29952..3bb6804 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file