1
0
Fork 0
mirror of https://github.com/seanmorley15/AdventureLog.git synced 2025-08-09 15:15:18 +02:00
AdventureLog/README.md
2024-04-10 19:48:47 -04:00

14 lines
674 B
Markdown

# AdventureLog: Embark, Explore, Remember. 🌍
_**⚠️ AdventureLog is in early development and is not recommended for production use until version 1.0!**_
### *"Never forget an adventure with AdventureLog - Your ultimate travel companion!"*
-----
## Installation
### Docker 🐋 (Recomended)
1. Clone the repository
2. Edit the `docker-compose.yml` file and change the database password
3. Run `docker compose up -d` to build the image and start the container
4. Wait for the app to start up and migrate then visit the port and enjoy!
**Note**: The `ORIGIN` variable is required for CSRF protection. It can be omitted if using a reverse proxy or other HTTPS service.