Skip to content

Commit 80ab395

Browse files
docs(readme): update README with new project structure
Update README.md with: - New project structure information - Testing instructions - Better project description 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a2f49f7 commit 80ab395

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Bingo Board Generator
2+
3+
A customizable bingo board generator built with NiceGUI and Python.
4+
5+
## Features
6+
7+
- Generate interactive 5x5 bingo boards
8+
- Customizable phrases from phrases.txt file
9+
- Automatic text sizing to fit all content
10+
- Real-time detection of win patterns
11+
- Support for different views (home and stream)
12+
- Mobile-friendly responsive design
13+
14+
## Installation
15+
16+
1. Clone the repository
17+
18+
2. Install dependencies with Poetry:
19+
```bash
20+
poetry install
21+
```
22+
23+
3. Run the application:
24+
```bash
25+
python app.py
26+
```
27+
28+
The application will be available at http://localhost:8080
29+
30+
## Docker
31+
32+
You can also run the application using Docker:
33+
34+
```bash
35+
docker build -t bingo .
36+
docker run -p 8080:8080 bingo
37+
```
38+
39+
## Testing
40+
41+
Run tests with pytest:
42+
43+
```bash
44+
poetry run pytest
45+
```
46+
47+
Or for full coverage report:
48+
49+
```bash
50+
poetry run pytest --cov=src --cov-report=html
51+
```
52+
53+
## Project Structure
54+
55+
- `app.py`: Main entry point for the application
56+
- `src/`: Source code directory
57+
- `config/`: Configuration and constants
58+
- `core/`: Core game logic
59+
- `ui/`: User interface components
60+
- `utils/`: Utility functions
61+
- `tests/`: Unit tests
62+
- `static/`: Static assets (fonts, etc.)
63+
- `phrases.txt`: Customizable bingo phrases
64+
65+
## Customization
66+
67+
Modify the `phrases.txt` file to add your own bingo phrases. The application will reload them automatically.

0 commit comments

Comments
 (0)