README.md

PALAVRA

Palavra é um jogo baseado na web, inspirado no popular jogo online Wordle (ou term.ooo).
No Palavra, os jogadores devem adivinhar uma palavra oculta dentro de um número limitado de tentativas.
O jogo fornece feedback sobre a precisão das tentativas para ajudar os jogadores a deduzirem a palavra correta.

NENHUMA ALTERAÇÃO PODE SER FEITA NESTE PROJETO SEM A DEVIDA COMUNICAÇÃO E AUTORIZAÇÃO.

Funcionalidades

• Interface interativa e amigável
• Feedback em tempo real sobre as tentativas
• Jogabilidade simples e envolvente
• Possibilidade de salvar a evolução no jogo
• Sistema de conquistas e recompensas

Instalação

Clonando o repositório

git clone https://github.com/leticia-pontes/eng-software-3bcc
cd eng-software-3bcc

Com Docker

1. Construa a imagem Docker:

   docker build -t palavra .

2. Execute o container:

   docker run -d -p 5200:5200 --name palavra-container palavra

3. Acesse o aplicativo em seu navegador:

   http://localhost:5200

Sem Docker

1. Crie um ambiente virtual (opcional, mas recomendado):

   python -m venv venv
   source venv/bin/activate  # Para Linux/Mac
   venv\Scripts\activate  # Para Windows

2. Instale as dependências:

   pip install -r requirements.txt

3. Aplique as migrações do banco de dados:

   python manage.py migrate

4. Execute o script de inserção no banco de dados:

   python palavra/criar_dicionario.py

5. Execute o servidor de desenvolvimento do Django:

   python manage.py runserver

6. Acesse o aplicativo em seu navegador:

   http://localhost:8000

Como Jogar

1. Inicie o jogo visitando o servidor de desenvolvimento local e clicando em JOGAR.
2. Efetue o Login. Se não tiver um usuário, crie um em Cadastre-se.
3. Insira sua tentativa no campo de entrada.
4. Envie sua tentativa e receba o feedback.
5. Use o feedback para adivinhar a palavra dentro das tentativas dadas.

Testes

Execute os testes para garantir que a aplicação está funcionando corretamente:

python manage.py test

Para verificar a cobertura de código:

coverage run --source='.' manage.py test
coverage report

Pipeline de CI/CD

O projeto utiliza o GitLab CI/CD para integração e implantação contínuas. O pipeline está definido no arquivo .gitlab-ci.yml e inclui etapas para testes, construção e implantação da aplicação.

Docker e Registro de Imagens

O projeto é containerizado usando Docker. A imagem Docker é construída e armazenada no Registro de Contêineres do GitLab.

Licença

Nenhuma (até o momento).

Contribuidores (integrantes do grupo)

• Beatriz Barbosa Bandeira
• Giovana Cristina dos Santos Castro
• Giovana dos Santos Oliveira
• Isabella Estella de Oliveira
• Letícia Alves de Pontes

Agradecimentos

• Inspirado nos originais Wordle e Termo