Merge pull request #23 from SBD1/doc/arrumando-readme

Doc/arrumando readme

README.md

@@ -21,17 +21,96 @@
 
 Fear & Hunger é um jogo de role-playing sombrio que mergulha os jogadores em um universo perturbador e desafiador. Este projeto tem fins educativos e busca auxiliar na compreensão de Sistemas de Gerenciamento de Bancos de Dados. Exploraremos, dentro das limitações impostas pelo tempo da disciplina e do escopo do projeto, a vasta e sinistra narrativa desse título, destacando sua complexa mecânica de jogo, personagens e enredo envolventes que mergulham os jogadores em um mundo sombrio repleto de horrores inimagináveis. A proposta é fazer um pequeno jogo baseado em texto que se passe no mesmo universo de Fear and Hunger.
 
-Exploraremos a forma como os dados são organizados e armazenados para construir uma experiencia de horror com uma dinamica semelhante a da saga original. Buscaremos reproduzir a mecanica de combate com características de RPG, sistema de crafting de itens, interação entre personagens, lojas, entre outros. Aprofundaremos nosso estudo nos esquemas de banco de dados e relacionamentos no contexto desse mundo sombrio, injusto e repleto de horrores inimagináveis.
+# Como Rodar o Projeto
 
-## Como Rodar o Projeto
+## Pré-requisitos do Sistema
 
-[Instruções de como rodar o projeto](https://github.com/SBD1/2023.2_Fear_and_Hunger/tree/main/game/README.md)
+Certifique-se de que os seguintes itens estejam instalados antes de prosseguir:
 
-## Apresentações
+- [Node.js](https://nodejs.org/en/)
+- [Docker](https://docs.docker.com/engine/installation/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+
+## Comandos para Execução da Aplicação
+
+### Build e Execução da Aplicação
+
+Para construir o projeto e iniciar a aplicação, utilize o seguinte comando:
+
+```
+make build
+```
+
+### Suspensão da Aplicação
+
+Para interromper a execução da aplicação, utilize o comando:
+
+```
+make stop
+```
+
+### Inicialização da Aplicação (Após o Build)
+
+Se a aplicação já estiver construída, inicie-a com o seguinte comando:
+
+```
+make start
+```
+
+### Reinicialização da Aplicação (Para Migrações)
+
+Caso seja necessário reiniciar a aplicação para efetuar migrações, utilize o comando:
+
+```
+make restart
+```
+
+
+### Limpeza de Volumes e Containers Docker
+
+Para limpar volumes e containers do Docker, execute:
+
+```
+make prune
+```
+
+### Limpeza Completa do Docker (Cuidado ao Usar)
+
+Para limpar completamente o ambiente Docker (atenção: este comando remove todos os volumes e containers), utilize com cautela:
+
+```
+make clean
+```
+
+Certifique-se de compreender as consequências antes de executar o último comando.
+
+## Apos fazer o build
+
+O Projeto se encontra disponível na porta `http://localhost:5173`.
+
+## Como acessar o PgAdmin
+ Abra um navegador da web e vá para http://localhost:80. Você será direcionado para a interface do PGAdmin.
+
+ Faça o login: Use as credenciais que você definiu nas variáveis de ambiente:
+  - E-mail: `[email protected]`
+  - Senha: `adminpassword`
+
+Adicionar um servidor PostgreSQL:
+
+- No PGAdmin, clique em "Adicionar Novo Servidor".
+- Em "General", insira um nome para o servidor: `sbd1_database`.
+- Em "Conexão", configure as seguintes informações:
+  - Hostname/address: `db`.
+  - Port: `5432`
+  - Username: `postgres`
+  - Password: `postgres`
+-  Depois de preencher essas informações, clique em "Salvar".
+
+# Apresentações
 [Apresentação do Módulo 1](https://youtu.be/hq5K7pO5bPs) <br>
 [Apresentação do Módulo 2](https://www.youtube.com/watch?v=rAxV4Q2LYVc) <br>
 
-## Entregas
+# Entregas
 
 - Módulo 1
   - [DER](https://sbd1.github.io/2023.2_Fear_and_Hunger/#/./modulo_01/der)