hotpocket/README.md
2025-08-18 11:18:41 +02:00

55 lines
1.3 KiB
Markdown

# HotPocket by BTHLabs
This repository contains the _HotPocket_ project.
## Development setup
### Requirements:
* Python 3.12,
* Poetry 1.8.3,
* `git-crypt`,
* Docker with Docker Compose and Buildx.
### Setup
1. `$ git-crypt unlock KEYFILE`
1. `$ poetry install`
1. `$ docker buildx bake`
1. `$ poetry run inv setup`
### Running local development stack
1. `$ docker compose up`
**Exported services:**
* The app: https://app.hotpocket.work.bthlabs.net:8000/
* The admin: https://app.hotpocket.work.bthlabs.net:8000/
* Keycloak: https://auth.hotpocket.work.bthlabs.net:8443/
* Postgres: postgres://postgres.hotpocket.work.bthlabs.net:5432/
* RabbitMQ: amqp://rabbitmq.hotpocket.work.bthlabs.net:5672/
* RabbitMQ Management: amqp://rabbitmq.hotpocket.work.bthlabs.net:15672/
**Default credentials:**
The default credentials across most of the services are:
`hotpocket:hotpocketm4st3r`. This applies to the initial app and admin account,
Keycloak master realm, Postgres and RabbitMQ.
The Keycloak `hotpocket-development` realm user's credentials are:
`hotpocket@bthlabs.net:hotpocketm4st3r`. You can use these to log in to the app
and admin using OIDC.
## Deployment
TODO
## Author
_HotPocket_ is developed by [BTHLabs](https://www.bthlabs.pl/).
## License
_HotPocket_ is licensed under the Apache 2.0 License.