From 7d0c4980e4b6594b1746e227e396f8eb33a97ee2 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 20 Apr 2026 23:08:58 +0000 Subject: [PATCH 1/2] Initial plan From 345033a0bb3bebacf1fbda9fc015d26007c6801f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 20 Apr 2026 23:10:50 +0000 Subject: [PATCH 2/2] docs: make README more engaging as a landing page Agent-Logs-Url: https://github.com/nick863/my-soc-ops-python/sessions/49602585-ba96-4bdd-ba2f-ad197c4965ce Co-authored-by: nick863 <30440255+nick863@users.noreply.github.com> --- README.es.md | 94 +++++++++++++++++++++++++++++++++++++++++-------- README.md | 94 +++++++++++++++++++++++++++++++++++++++++-------- README.pt_BR.md | 94 +++++++++++++++++++++++++++++++++++++++++-------- 3 files changed, 237 insertions(+), 45 deletions(-) diff --git a/README.es.md b/README.es.md index 1e85c23..d9a5a22 100644 --- a/README.es.md +++ b/README.es.md @@ -1,26 +1,90 @@ 🌐 [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 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 preguntas, marca tu cartón y corre para conseguir 5 en fila! -## 📚 Guía del Laboratorio +## ✨ Características -| Parte | Título | -|-------|--------| -| [**00**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=00-overview) | Visión General y Lista de Verificación | -| [**01**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=01-setup) | Configuración y Context Engineering | -| [**02**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=02-design) | Desarrollo Frontend Orientado al Diseño | -| [**03**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=03-quiz-master) | Quiz Master Personalizado | -| [**04**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=04-multi-agent) | Desarrollo Multi-Agente | +- 🎲 **Tableros aleatorios** — Cada jugador recibe una disposición única +- 💾 **Progreso guardado automáticamente** — Continúa donde lo dejaste +- 🏆 **Detección de bingo** — Detección automática de victorias en filas, columnas y diagonales +- 🎉 **Modal de celebración** — Pantalla de victoria digna de confeti +- 📱 **Mobile-first** — Funciona genial en teléfonos durante eventos -> 📝 Las guías del laboratorio también están disponibles en la carpeta [`workshop/`](workshop/) para lectura sin conexión. +## 🚀 Inicio Rápido ---- +### Requisitos previos +- [Python 3.13+](https://www.python.org/downloads/) +- [uv](https://docs.astral.sh/uv/) (gestor de paquetes Python) -## 🚀 Primeros Pasos +### Ejecutar localmente +```bash +uv sync +uv run uvicorn app.main:app --reload --port 8000 +# Abrir http://localhost:8000 +``` -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. +### Pruebas +```bash +uv run pytest +``` + +### Lint +```bash +uv run ruff check . +``` + +## 🎨 Personaliza tu Juego + +### Cambiar Preguntas +Edita `app/data.py` para agregar tus propios prompts de presentació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 Lab](workshop/GUIDE.md) para una experiencia práctica con los agentes de GitHub Copilot. + +## 🛠️ Tecnologías + +- **Framework**: FastAPI + Jinja2 + HTMX +- **Estilos**: Utilidades CSS personalizadas (inspirado en Tailwind) +- **Estado**: Sesiones server-side con persistencia en cookies +- **Despliegue**: GitHub Pages via Actions + +## 📁 Estructura del Proyecto + +``` +app/ +├── templates/ # Plantillas Jinja2 +│ ├── base.html +│ ├── home.html +│ └── components/ # bingo_board, bingo_modal, game_screen, start_screen +├── static/ # Archivos CSS & JS +├── models.py # Estado del juego & modelos de datos +├── game_logic.py # Detección de bingo & generación de tableros +├── game_service.py # Gestión de sesiones +├── data.py # Banco de preguntas +└── main.py # Rutas FastAPI +tests/ +├── test_api.py # Pruebas de endpoints de API +└── test_game_logic.py # Pruebas unitarias de lógica del juego +``` + +## 🚢 Despliegue + +Se despliega automáticamente en GitHub Pages con cada push a `main`: +- Tu juego: `https://{usuario}.github.io/{nombre-del-repo}` + +## 📝 Licencia + +MIT — ¡úsalo para tu próximo evento! diff --git a/README.md b/README.md index a67fd02..b4b5b34 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,89 @@ 🌐 [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! -## 📚 Lab Guide +## ✨ Features -| Part | Title | -|------|-------| -| [**00**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=00-overview) | Overview & Checklist | -| [**01**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=01-setup) | Setup & Context Engineering | -| [**02**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=02-design) | Design-First Frontend | -| [**03**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=03-quiz-master) | Custom Quiz Master | -| [**04**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=04-multi-agent) | Multi-Agent Development | +- 🎲 **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 -> 📝 Lab guides are also available in the [`workshop/`](workshop/) folder for offline reading. +## 🚀 Quick Start ---- +### Prerequisites +- [Python 3.13+](https://www.python.org/downloads/) +- [uv](https://docs.astral.sh/uv/) (Python package manager) -## 🚀 Getting Started +### Run Locally +```bash +uv sync +uv run uvicorn app.main:app --reload --port 8000 +# Open http://localhost:8000 +``` -Head to **[Part 00: Overview](https://copilot-dev-days.github.io/agent-lab-python/step.html?step=00-overview)** for prerequisites and setup instructions. +### 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}` + +## 📝 License + +MIT — use it for your next event! diff --git a/README.pt_BR.md b/README.pt_BR.md index 92087a9..5a4ddab 100644 --- a/README.pt_BR.md +++ b/README.pt_BR.md @@ -1,26 +1,90 @@ 🌐 [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 sua cartela e corra para conseguir 5 em linha! -## 📚 Guia do Lab +## ✨ Funcionalidades -| Parte | Título | -|-------|--------| -| [**00**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=00-overview) | Visão Geral & Lista de Verificação | -| [**01**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=01-setup) | Configuração & Engenharia de Contexto | -| [**02**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=02-design) | Frontend Design-First | -| [**03**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=03-quiz-master) | Quiz Master Personalizado | -| [**04**](https://copilot-dev-days.github.io/agent-lab-python/docs/step.html?step=04-multi-agent) | Desenvolvimento Multi-Agente | +- 🎲 **Cartelas aleatórias** — Cada jogador recebe uma disposição única +- 💾 **Progresso salvo automaticamente** — Continue de onde parou +- 🏆 **Detecção de bingo** — Vitória automática em linhas, colunas e diagonais +- 🎉 **Modal de celebração** — Tela de vitória digna de confetes +- 📱 **Mobile-first** — Funciona muito bem em celulares durante eventos -> 📝 Os guias do lab também estão disponíveis na pasta [`workshop/`](workshop/) para leitura offline. +## 🚀 Início Rápido ---- +### Pré-requisitos +- [Python 3.13+](https://www.python.org/downloads/) +- [uv](https://docs.astral.sh/uv/) (gerenciador de pacotes Python) -## 🚀 Primeiros Passos +### Executar Localmente +```bash +uv sync +uv run uvicorn app.main:app --reload --port 8000 +# Abra http://localhost:8000 +``` -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. +### 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 apresentação: +```python +questions_list: list[str] = [ + "tem um animal de estimação", + "fala mais de 2 idiomas", + "sua pergunta personalizada aqui", + # ... 24+ perguntas para uma cartela completa +] +``` + +### Guia do Workshop +👉 Siga o [Guia do Lab](workshop/GUIDE.md) para uma experiência prática com os agentes do GitHub Copilot. + +## 🛠️ Tecnologias + +- **Framework**: FastAPI + Jinja2 + HTMX +- **Estilização**: Utilitários CSS personalizados (inspirado no Tailwind) +- **Estado**: Sessões server-side com persistência em cookies +- **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/ # Arquivos CSS & JS +├── models.py # Estado do jogo & modelos de dados +├── game_logic.py # Detecção de bingo & geração de cartelas +├── game_service.py # Gerenciamento de sessão +├── data.py # Banco de perguntas +└── main.py # Rotas FastAPI +tests/ +├── test_api.py # Testes dos endpoints da API +└── test_game_logic.py # Testes unitários da lógica do jogo +``` + +## 🚢 Deploy + +Deploy automático no GitHub Pages a cada push para `main`: +- Seu jogo: `https://{usuario}.github.io/{nome-do-repo}` + +## 📝 Licença + +MIT — use para o seu próximo evento!