BGG Data Explorer

Overview

BGG Data Explorer is a comprehensive web application for exploring BoardGameGeek (BGG) game data. The application provides an interactive interface to search and filter board games based on various criteria.

Project Structure

• backend/: FastAPI backend server
• frontend/: HTML, CSS, and JavaScript frontend
• Makefile: Development task automation

Prerequisites

• Python 3.12+
• uv (Universal Virtualenv) for dependency management

Setup and Installation

1. Install UV

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
winget install --id=astral-sh.uv -e
# or
scoop install main/uv

2. Clone the Repository

git clone https://github.com/yourusername/bgg-data-explorer.git
cd bgg-data-explorer

3. Set Up Development Environment

# Synchronize project dependencies
make setup

Development Workflow

Start Backend Server

make backend

• Runs on http://localhost:8000
• Auto-reloads on code changes

Open Frontend

make frontend

• Opens frontend/index.html in default web browser

Run Both Backend and Frontend

make start

Additional Commands

• make update: Update and synchronize project dependencies
• make test: Run project tests
• make lint: Run code quality checks
• make clean: Remove build artifacts

Technologies

• Backend: FastAPI, Python
• Frontend: Alpine.js, Tailwind CSS
• Development: UV, Pytest, Ruff, Black, MyPy

Features

• Filter board games by:
  • Year published
  • Geek Rating
  • Publishers
• Dynamic search functionality
• BGG game links

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.