README.md

# rebuild

Our MQTT integrative project, designed to keep societies and their members
in touch.

## Resources

- [Pitch](https://livecoventryac-my.sharepoint.com/:p:/g/personal/kellowa_uni_coventry_ac_uk/EQ3k-IcQoctEhsVOWj4I29QBWOS3t9M1ZL6xYv5Qm9AIVQ)
- [Gantt chart](https://app.teamgantt.com/projects/gantt?ids=3835418)
- [Minutes/Log](https://www.canva.com/design/DAF8qsVXJIE/7IdHtNHhnb1p8Qlyn2n-_g/edit?utm_content=DAF8qsVXJIE&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton)

## Modules

### `broker`

This module provides the exchange for messages between clients.

### `client`

This module handles messages for and from the broker and provides the UI for
rebuild.

### `db`

This module handles the database initialisation and running. It also provides
a driver for the `client`.

## Development

When working on rebuild, ensure you have [`pdm`] installed. To initialise the
dependencies, use `pdm install`, and then `pdm run pre-commit install` to set
up the pre-commit hooks. This will ensure all contributed code meets the project
standards.

[`pdm`]: https://pdm-project.org/latest/