From 070d537a8bf053123ae3db3d8e48f25cc7c858dc Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 20 Apr 2026 22:44:43 +0000 Subject: [PATCH 1/2] Initial plan From ed63195ddcb7b8d9f67c7b7c66c5683f52e167bb Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 20 Apr 2026 22:47:00 +0000 Subject: [PATCH 2/2] docs: make README more engaging as a project landing page - Add emoji title, tagline quote, and rich description to README.md - Add Features, Quick Start, Customize, Tech Stack, Project Structure, and Deployment sections drawn from the solution reference - Reposition Lab Guide table as a secondary section (after project content) - Update README.pt_BR.md (Portuguese) with full translated content - Update README.es.md (Spanish) with full translated content Agent-Logs-Url: https://github.com/prashantchahar/my-soc-ops-python/sessions/40232446-9be1-4cfb-afad-c5aa550dc18f Co-authored-by: prashantchahar <19215720+prashantchahar@users.noreply.github.com> --- README.es.md | 90 +++++++++++++++++++++++++++++++++++++++++++++---- README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++---- README.pt_BR.md | 90 +++++++++++++++++++++++++++++++++++++++++++++---- 3 files changed, 249 insertions(+), 21 deletions(-) diff --git a/README.es.md b/README.es.md index 1e85c23..69e9958 100644 --- a/README.es.md +++ b/README.es.md @@ -1,11 +1,89 @@ 🌐 [Português (BR)](README.pt_BR.md) | [Español](README.es.md) -# Soc Ops +# 🎯 Soc Ops — Social Bingo -Juego de Bingo Social para encuentros presenciales. ¡Encuentra personas que coincidan con las preguntas y consigue 5 en fila! +> **¡Rompe el hielo, haz conexiones, gana en el networking!** ---- +Soc Ops es un juego interactivo de bingo social diseñado para encuentros presenciales, eventos de equipo y conferencias. ¡Encuentra personas que coincidan con las pistas, marca tu cartón y compite por conseguir 5 en fila! + +## ✨ Características + +- 🎲 **Tableros aleatorios** — Cada jugador recibe un arreglo único +- 💾 **Progreso guardado automáticamente** — Continúa donde lo dejaste +- 🏆 **Detección de bingo** — Detección automática de victoria en filas, columnas y diagonales +- 🎉 **Modal de celebración** — Pantalla de victoria digna de confeti +- 📱 **Mobile-first** — Funciona genial en teléfonos en eventos + +## 🚀 Inicio Rápido + +### Prerrequisitos +- [Python 3.13+](https://www.python.org/downloads/) +- [uv](https://docs.astral.sh/uv/) (gestor de paquetes Python) + +### Ejecutar Localmente +```bash +uv sync +uv run uvicorn app.main:app --reload --port 8000 +# Abre http://localhost:8000 +``` + +### Pruebas +```bash +uv run pytest +``` + +### Lint +```bash +uv run ruff check . +``` + +## 🎨 Personaliza Tu Juego + +### Cambiar Preguntas +Edita `app/data.py` para añadir tus propios prompts de introducción: +```python +questions_list: list[str] = [ + "tiene una mascota", + "habla más de 2 idiomas", + "tu pregunta personalizada aquí", + # ... 24+ preguntas para un tablero completo +] +``` + +### Guía del Workshop +👉 Sigue la [Guía del Laboratorio](workshop/GUIDE.md) para una experiencia práctica de taller con agentes de GitHub Copilot. + +## 🛠️ Stack Tecnológico + +- **Framework**: FastAPI + Jinja2 + HTMX +- **Estilos**: Utilidades CSS personalizadas (inspiradas en Tailwind) +- **Estado**: Sesiones en el servidor con persistencia en cookie +- **Despliegue**: GitHub Pages mediante Actions + +## 📁 Estructura del Proyecto + +``` +app/ +├── templates/ # Plantillas Jinja2 +│ ├── base.html +│ ├── home.html +│ └── components/ # bingo_board, bingo_modal, game_screen, start_screen +├── static/ # Assets CSS & JS +├── models.py # Estado del juego & modelos de datos +├── game_logic.py # Detección de bingo & generación de tablero +├── game_service.py # Gestión de sesiones +├── data.py # Banco de preguntas +└── main.py # Rutas FastAPI +tests/ +├── test_api.py # Tests de endpoints de la API +└── test_game_logic.py # Tests unitarios de la lógica del juego +``` + +## 🚢 Despliegue + +Se despliega automáticamente en GitHub Pages al hacer push a `main`: +- Tu juego: `https://{usuario}.github.io/{nombre-del-repo}` ## 📚 Guía del Laboratorio @@ -19,8 +97,6 @@ Juego de Bingo Social para encuentros presenciales. ¡Encuentra personas que coi > 📝 Las guías del laboratorio también están disponibles en la carpeta [`workshop/`](workshop/) para lectura sin conexión. ---- - -## 🚀 Primeros Pasos +## 📝 Licencia -Dirígete a **[Parte 00: Visión General](https://copilot-dev-days.github.io/agent-lab-python/step.html?step=00-overview)** para los requisitos previos e instrucciones de configuración. +MIT — ¡úsalo en tu próximo evento! diff --git a/README.md b/README.md index a67fd02..aa43caf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,88 @@ 🌐 [Português (BR)](README.pt_BR.md) | [Español](README.es.md) -# Soc Ops +# 🎯 Soc Ops — Social Bingo -Social Bingo game for in-person mixers. Find people who match the questions and get 5 in a row! +> **Break the ice, make connections, win at networking!** ---- +Soc Ops is an interactive social bingo game designed for in-person mixers, team events, and conferences. Find people who match the prompts, mark your card, and race to get 5 in a row! + +## ✨ Features + +- 🎲 **Randomized boards** — Every player gets a unique arrangement +- 💾 **Auto-save progress** — Pick up where you left off +- 🏆 **Bingo detection** — Automatic win detection for rows, columns, and diagonals +- 🎉 **Celebration modal** — Confetti-worthy victory screen +- 📱 **Mobile-first** — Works great on phones at events + +## 🚀 Quick Start + +### Prerequisites +- [Python 3.13+](https://www.python.org/downloads/) +- [uv](https://docs.astral.sh/uv/) (Python package manager) + +### Run Locally +```bash +uv sync +uv run uvicorn app.main:app --reload --port 8000 +# Open http://localhost:8000 +``` + +### Test +```bash +uv run pytest +``` + +### Lint +```bash +uv run ruff check . +``` + +## 🎨 Customize Your Game + +### Change Questions +Edit `app/data.py` to add your own icebreaker prompts: +```python +questions_list: list[str] = [ + "has a pet", + "speaks more than 2 languages", + "your custom question here", + # ... 24+ questions for a full board +] +``` + +### Workshop Guide +👉 Follow the [Lab Guide](workshop/GUIDE.md) for a hands-on workshop experience with GitHub Copilot agents. + +## 🛠️ Tech Stack + +- **Framework**: FastAPI + Jinja2 + HTMX +- **Styling**: Custom CSS utilities (Tailwind-inspired) +- **State**: Server-side sessions with cookie persistence +- **Deployment**: GitHub Pages via Actions + +## 📁 Project Structure + +``` +app/ +├── templates/ # Jinja2 templates +│ ├── base.html +│ ├── home.html +│ └── components/ # bingo_board, bingo_modal, game_screen, start_screen +├── static/ # CSS & JS assets +├── models.py # Game state & data models +├── game_logic.py # Bingo detection & board generation +├── game_service.py # Session management +├── data.py # Question bank +└── main.py # FastAPI routes +tests/ +├── test_api.py # API endpoint tests +└── test_game_logic.py # Game logic unit tests +``` + +## 🚢 Deployment + +Automatically deploys to GitHub Pages on push to `main`: +- Your game: `https://{username}.github.io/{repo-name}` ## 📚 Lab Guide @@ -18,8 +96,6 @@ Social Bingo game for in-person mixers. Find people who match the questions and > 📝 Lab guides are also available in the [`workshop/`](workshop/) folder for offline reading. ---- - -## 🚀 Getting Started +## 📝 License -Head to **[Part 00: Overview](https://copilot-dev-days.github.io/agent-lab-python/step.html?step=00-overview)** for prerequisites and setup instructions. +MIT — use it for your next event! diff --git a/README.pt_BR.md b/README.pt_BR.md index 92087a9..91bcc23 100644 --- a/README.pt_BR.md +++ b/README.pt_BR.md @@ -1,11 +1,89 @@ 🌐 [Português (BR)](README.pt_BR.md) | [Español](README.es.md) -# Soc Ops +# 🎯 Soc Ops — Social Bingo -Jogo de Bingo Social para encontros presenciais. Encontre pessoas que correspondam às perguntas e consiga 5 em linha! +> **Quebre o gelo, faça conexões, vença no networking!** ---- +Soc Ops é um jogo interativo de bingo social projetado para encontros presenciais, eventos de equipe e conferências. Encontre pessoas que correspondam às perguntas, marque seu cartão e seja o primeiro a conseguir 5 em linha! + +## ✨ Funcionalidades + +- 🎲 **Cartelas aleatórias** — Cada jogador recebe um arranjo único +- 💾 **Progresso salvo automaticamente** — Continue de onde parou +- 🏆 **Detecção de bingo** — Detecção automática de vitória em linhas, colunas e diagonais +- 🎉 **Modal de celebração** — Tela de vitória digna de confetes +- 📱 **Mobile-first** — Funciona ótimo em celulares em eventos + +## 🚀 Início Rápido + +### Pré-requisitos +- [Python 3.13+](https://www.python.org/downloads/) +- [uv](https://docs.astral.sh/uv/) (gerenciador de pacotes Python) + +### Executar Localmente +```bash +uv sync +uv run uvicorn app.main:app --reload --port 8000 +# Abra http://localhost:8000 +``` + +### Testar +```bash +uv run pytest +``` + +### Lint +```bash +uv run ruff check . +``` + +## 🎨 Personalize Seu Jogo + +### Alterar Perguntas +Edite `app/data.py` para adicionar seus próprios prompts de quebra-gelo: +```python +questions_list: list[str] = [ + "tem um animal de estimação", + "fala mais de 2 idiomas", + "sua pergunta personalizada aqui", + # ... 24+ perguntas para um cartão completo +] +``` + +### Guia do Workshop +👉 Siga o [Guia do Lab](workshop/GUIDE.md) para uma experiência prática de workshop com agentes do GitHub Copilot. + +## 🛠️ Stack Tecnológica + +- **Framework**: FastAPI + Jinja2 + HTMX +- **Estilização**: Utilitários CSS personalizados (inspirados no Tailwind) +- **Estado**: Sessões no lado do servidor com persistência em cookie +- **Deploy**: GitHub Pages via Actions + +## 📁 Estrutura do Projeto + +``` +app/ +├── templates/ # Templates Jinja2 +│ ├── base.html +│ ├── home.html +│ └── components/ # bingo_board, bingo_modal, game_screen, start_screen +├── static/ # Assets CSS & JS +├── models.py # Estado do jogo & modelos de dados +├── game_logic.py # Detecção de bingo & geração de cartela +├── game_service.py # Gerenciamento de sessão +├── data.py # Banco de perguntas +└── main.py # Rotas FastAPI +tests/ +├── test_api.py # Testes de endpoint da API +└── test_game_logic.py # Testes unitários da lógica do jogo +``` + +## 🚢 Deploy + +Faz deploy automaticamente no GitHub Pages ao fazer push para `main`: +- Seu jogo: `https://{usuario}.github.io/{nome-do-repo}` ## 📚 Guia do Lab @@ -19,8 +97,6 @@ Jogo de Bingo Social para encontros presenciais. Encontre pessoas que correspond > 📝 Os guias do lab também estão disponíveis na pasta [`workshop/`](workshop/) para leitura offline. ---- - -## 🚀 Primeiros Passos +## 📝 Licença -Acesse **[Parte 00: Visão Geral](https://copilot-dev-days.github.io/agent-lab-python/step.html?step=00-overview)** para pré-requisitos e instruções de configuração. +MIT — use no seu próximo evento!