File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed
Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change 1+ # BINGO Project Guide
2+
3+ ## Build Commands
4+ ``` bash
5+ # Install dependencies
6+ poetry install
7+
8+ # Run application
9+ poetry run python main.py
10+
11+ # Build Docker container
12+ docker build -t bingo .
13+
14+ # Run Docker container
15+ docker run -p 8080:8080 bingo
16+
17+ # Helm deployment
18+ cd helm && ./package.sh && helm install bingo ./bingo
19+ ```
20+
21+ ## Code Style Guidelines
22+ - ** Imports** : Standard library first, third-party second, local modules last
23+ - ** Formatting** : Use f-strings for string formatting
24+ - ** Constants** : Defined at top of file in UPPER_CASE
25+ - ** Naming** : snake_case for functions/variables, UPPER_CASE for constants
26+ - ** Error Handling** : Use try/except blocks with proper logging
27+ - ** UI Elements** : Define class constants for styling
28+ - ** Logging** : Use Python's logging module with descriptive messages
29+ - ** Comments** : Use docstrings for functions and descriptive comments
30+
31+ ## Project Structure
32+ - ` main.py ` : Core application with NiceGUI implementation
33+ - ` phrases.txt ` : Contains customizable bingo phrases
34+ - ` static/ ` : Static assets for fonts and styles
35+ - ` helm/ ` : Kubernetes deployment configuration
You can’t perform that action at this time.
0 commit comments