Skip to main content

Local Development

This guide is for contributors and plugin developers who want to work on FiestaBoard's code. If you just want to host a FiestaBoard server to control your board, see the Quick Start instead.

Development with Docker Compose​

The recommended way to develop FiestaBoard:

# Build and run development environment
docker-compose -f docker-compose.dev.yml up --build

# Access Web UI at http://localhost:3000
# Access API at http://localhost:8000

The development environment includes hot reload for both Python and Next.js code.

Project Structure​

FiestaBoard/
├── plugins/                    # Plugin-based data sources
│   ├── _template/              # Template for new plugins
│   ├── weather/                # Weather plugin
│   ├── stocks/                 # Stocks plugin
│   └── .../                    # Other plugins
├── src/                        # Platform core (API, display service)
│   ├── api_server.py           # FastAPI REST API
│   ├── main.py                 # Display service core
│   ├── config.py               # Configuration management
│   └── plugins/                # Plugin system infrastructure
├── web/                        # Next.js web UI
│   └── src/                    # React components and pages
├── docs-site/                  # Docusaurus documentation
├── tests/                      # Platform test suite
├── Dockerfile.api              # API service Dockerfile
├── Dockerfile.ui               # Web UI Dockerfile
├── docker-compose.yml          # Production compose
└── docker-compose.dev.yml      # Development compose

Running Tests​

# Run web UI tests
npm run test:web

# Run Python tests
pytest tests/

Code Style​

The project uses:

  • ESLint for JavaScript/TypeScript
  • Pylint for Python
# Lint web code
npm run lint:web

Next Steps​