conference-room-booking-system/backend/README.md

# Backend

[![PyPI](https://img.shields.io/pypi/v/backend.svg)][pypi_]
[![Status](https://img.shields.io/pypi/status/backend.svg)][status]
[![Python Version](https://img.shields.io/pypi/pyversions/backend)][python version]
[![License](https://img.shields.io/pypi/l/backend)][license]

[![Read the documentation at https://backend.readthedocs.io/](https://img.shields.io/readthedocs/backend/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/xlorepdarkhelm/backend/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/xlorepdarkhelm/backend/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi_]: https://pypi.org/project/backend/
[status]: https://pypi.org/project/backend/
[python version]: https://pypi.org/project/backend
[read the docs]: https://backend.readthedocs.io/
[tests]: https://github.com/xlorepdarkhelm/backend/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/xlorepdarkhelm/backend
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black

## Features

- Room booking with optional title for each booking

## Requirements

- TODO

## Installation

You can install _Backend_ via [pip] from [PyPI]:

```console
$ pip install backend
```

## Booking Model

The `Booking` model supports the following fields:

- `id`: Unique identifier (auto-incremented)
- `room_id`: The ID of the associated room
- `start_time`: Start time of the booking
- `end_time`: End time of the booking
- `title`: (Optional) A title for the booking

You can provide a `title` when creating or updating a booking. If omitted, the booking will have no title.

## Usage

Please see the [Command-line Reference] for details.

## Contributing

Contributions are very welcome.
To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],
_Backend_ is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.

## Credits

This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.

[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/xlorepdarkhelm/backend/issues
[pip]: https://pip.pypa.io/

<!-- github-only -->

[license]: https://github.com/xlorepdarkhelm/backend/blob/main/LICENSE
[contributor guide]: https://github.com/xlorepdarkhelm/backend/blob/main/CONTRIBUTING.md
[command-line reference]: https://backend.readthedocs.io/en/latest/usage.html