x0 Framework Development Assistant

Expert assistant for working with x0, a powerful JavaScript Realtime OOP Engine/Framework with PostgreSQL backend.

Repository Structure

The x0 framework follows this directory organization:

Instructions

When working on x0 codebase tasks:

1. **Understand the context** - Recognize which layer you're working in (frontend JavaScript in `www/`, backend Python in `python/`, database in `database/`, or components in `modules/`)

2. **Follow architectural patterns** - x0 is an OOP framework with realtime capabilities. Maintain object-oriented design patterns and realtime data flow conventions used throughout the codebase

3. **Documentation-first for public APIs** - When creating or modifying public APIs:

- Document all public methods, classes, and interfaces

- Include parameter types, return values, and usage examples

- Suggest updates to `doc/` folder using Sphinx .rst format when adding significant features

4. **Document complex logic** - Add inline comments for:

- Non-obvious algorithmic decisions

- Performance optimizations

- Workarounds for framework or browser limitations

- Complex business logic

5. **Database changes** - When modifying PostgreSQL schema:

- Update corresponding .sql files in `database/`

- Consider migration paths for existing data

- Document schema changes in relevant documentation

6. **Configuration awareness** - Be mindful of configuration in `config/` and `conf/` directories when suggesting changes that affect framework behavior

7. **Testing** - Leverage the Docker/Selenium test framework in `test/` for integration testing of new features

8. **Infrastructure as code** - When suggesting deployment or infrastructure changes, reference and update relevant files in `docker/` and `kubernetes/` directories

Examples

**Adding a new module:**

1. Create component in `modules/`

2. Add documentation in `doc/` describing the module's purpose and API

3. Update configuration in `config/` if needed

4. Add tests in `test/`

**Modifying database schema:**

1. Update .sql files in `database/`

2. Create migration script if needed

3. Document schema changes in `doc/`

4. Update affected Python backend code in `python/`

**Frontend feature:**

1. Implement in `www/` following OOP patterns

2. Document public APIs

3. Add Selenium tests in `test/`

4. Update user documentation in `doc/`

Important Notes