Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sauberr/bookings-project
Hotel booking website written by FastApi
https://github.com/sauberr/bookings-project
celery django docker grafana python redis
Last synced: 26 days ago
JSON representation
Hotel booking website written by FastApi
- Host: GitHub
- URL: https://github.com/sauberr/bookings-project
- Owner: Sauberr
- License: mit
- Created: 2023-09-02T14:35:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-09T22:10:01.000Z (30 days ago)
- Last Synced: 2024-12-09T22:24:14.629Z (30 days ago)
- Topics: celery, django, docker, grafana, python, redis
- Language: Python
- Homepage:
- Size: 147 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hotel Booking
This hotel booking application demonstrates the power of FastAPI and SQLAlchemy for building RESTful APIs. It incorporates Celery for asynchronous tasks, Redis for caching, Prometheus and Grafana for data monitoring and visualization and Docker for containerization, showcasing a modern approach to backend development.
#### Stack:
- [Python](https://www.python.org/downloads/)
- [PostgreSQL](https://www.postgresql.org/)
- [Redis](https://redis.io/)
- [Celery](https://docs.celeryq.dev/en/stable/)
- [Docker](https://www.docker.com/)
- [Prometheus](https://github.com/trallnag/prometheus-fastapi-instrumentator)
- [Grafana](https://grafana.com/)
## Local Developing
All actions should be executed from the source directory of the project and only after installing all requirements.
1. Firstly, create and activate a new virtual environment:
```bash
python3.11 -m venv ../venv
source ../venv/bin/activate
```
2. Install packages:
```bash
pip install --upgrade pip
pip install -r requirements.txt
```
## Run application
The uvicorn web server is used to run FastAPI. The command to run looks like this:
```
uvicorn app.main:app --reload
```
It must be run on the command line, always being in the root directory of the project.
### Celery & Flower
To start Celery use the command
```
celery --app=app.tasks.celery:celery worker -l INFO -P solo
Note that `-P solo` is only used on Windows, as Celery has problems working on Windows.
To start Flower use the command
```
celery --app=app.tasks.celery:celery flower
### Dockerfile
To run a web server (FastAPI) inside a container, you need to uncomment the code inside the Dockerfile and have an already running PostgreSQL instance on your machine.
Code to run Dockerfile:
```
docker build .
```
The command is also run from the root directory where the Dockerfile resides.
### Docker compose
To start all services (DB, Redis, web server (FastAPI), Celery, Flower, Grafana, Prometheus), you need to use the docker-compose.yml file and the commands
```
docker compose build
docker compose up
```
Moreover, the `build` command needs to be run only if you changed something inside the Dockerfile, that is, you changed the logic for compiling the image.
## License
This project uses the [MIT] license(https://github.com/Sauberr/bookings-project/blob/master/LICENSE)