Documentation can be found here.
Docker is the preferred way to run AdventureLog on your local machine. It is a lightweight containerization technology that allows you to run applications in isolated environments called containers. Note: This guide mainly focuses on installation with a linux based host machine, but the steps are similar for other operating systems.
- Docker installed on your machine/server. You can learn how to download it here.
Get the docker-compose.yml file from the AdventureLog repository. You can download it from here or run this command to download it directly to your machine:
wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/docker-compose.ymlHere is a summary of the configuration options available in the docker-compose.yml file:
| Name | Required | Description | Default Value |
|---|---|---|---|
PUBLIC_SERVER_URL |
Yes | What the frontend SSR server uses to connect to the backend. | http://server:8000 |
ORIGIN |
Sometimes | Not needed if using HTTPS. If not, set it to the domain of what you will acess the app from. | http://localhost:8080 |
BODY_SIZE_LIMIT |
Yes | Used to set the maximum upload size to the server. Should be changed to prevent someone from uploading too much! Custom values must be set in kiliobytes. | Infinity |
| Name | Required | Description | Default Value |
|---|---|---|---|
PGHOST |
Yes | Databse host. | db |
PGDATABASE |
Yes | Database. | database |
PGUSER |
Yes | Database user. | adventure |
PGPASSWORD |
Yes | Database password. | changeme123 |
DJANGO_ADMIN_USERNAME |
Yes | Default username. | admin |
DJANGO_ADMIN_PASSWORD |
Yes | Default password, change after inital login. | admin |
DJANGO_ADMIN_EMAIL |
Yes | Default user's email. | [email protected] |
PUBLIC_URL |
Yes | This is the publically accessible url to the nginx container. You should be able to acess nginx from this url where you access your app. | http://127.0.0.1:81 |
CSRF_TRUSTED_ORIGINS |
Yes | Need to be changed to the orgins where you use your backend server and frontend. These values are comma seperated. | Needs to be changed. |
FRONTEND_URL |
Yes | This is the publically accessible url to the frontend container. This link should be accessable for all users. Used for email generation. | http://localhost:3000 |
In order to use media files in a production environment, you need to configure the nginx container to serve the media files. The container is already in the docker compose file but you need to do a few things to make it work.
- Create a directory called
proxyin the same directory as thedocker-compose.ymlfile. - Create a file called
nginx.confin theproxydirectory. - Add the following configuration to the
nginx.conffile:
server {
listen 80;
server_name localhost;
location /media/ {
alias /app/media/;
}
}To start the containers, run the following command:
docker compose up -dEnjoy AdventureLog! 🎉
Displaying the adventures you have visited and the ones you plan to embark on. You can also filter and sort the adventures.
Shows specific details about an adventure, including the name, date, location, description, and rating.
View all of your adventures on a map, with the ability to filter by visit status and add new ones by click on the map.
️
AdventureLog is a Svelte Kit and Django application that utilizes a PostgreSQL database. Users can log the adventures they have experienced, as well as plan future ones. Key features include:
- Logging past adventures with fields like name, date, location, description, and rating.
- Planning future adventures with similar fields.
- Tagging different activity types for better organization.
- Viewing countries, regions, and marking visited regions.
AdventureLog aims to be your ultimate travel companion, helping you document your adventures and plan new ones effortlessly.
AdventureLog is licensed under the GNU General Public License v3.0.