-
-
{% endblock %}
diff --git a/backend/server/templates/login.html b/backend/server/templates/login.html
deleted file mode 100644
index 70d8081..0000000
--- a/backend/server/templates/login.html
+++ /dev/null
@@ -1,8 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-
-
Login
-{% endblock %}
diff --git a/backend/server/templates/logout.html b/backend/server/templates/logout.html
deleted file mode 100644
index 2ae28e2..0000000
--- a/backend/server/templates/logout.html
+++ /dev/null
@@ -1,8 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-
-
Logout
-{% endblock %}
diff --git a/backend/server/templates/password_change.html b/backend/server/templates/password_change.html
deleted file mode 100644
index 383dfc9..0000000
--- a/backend/server/templates/password_change.html
+++ /dev/null
@@ -1,39 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-
-
-
-
-
Update User Details
-{% endblock %}
-
-{% block script %}
-
-{% endblock %}
diff --git a/backend/server/templates/password_reset.html b/backend/server/templates/password_reset.html
deleted file mode 100644
index 9100bee..0000000
--- a/backend/server/templates/password_reset.html
+++ /dev/null
@@ -1,8 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-
-
Password reset
-{% endblock %}
diff --git a/backend/server/templates/password_reset_confirm.html b/backend/server/templates/password_reset_confirm.html
deleted file mode 100644
index 162cc35..0000000
--- a/backend/server/templates/password_reset_confirm.html
+++ /dev/null
@@ -1,26 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-
-
Password reset confirmation
-{% endblock %}
-
-
-
-{% block script %}
-
-{% endblock %}
diff --git a/backend/server/templates/resend_email_verification.html b/backend/server/templates/resend_email_verification.html
deleted file mode 100644
index 080a6f0..0000000
--- a/backend/server/templates/resend_email_verification.html
+++ /dev/null
@@ -1,8 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-
-
Resend E-mail verification
-{% endblock %}
diff --git a/backend/server/templates/signup.html b/backend/server/templates/signup.html
deleted file mode 100644
index 0854683..0000000
--- a/backend/server/templates/signup.html
+++ /dev/null
@@ -1,8 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-
-
Signup
-{% endblock %}
diff --git a/backend/server/templates/user_details.html b/backend/server/templates/user_details.html
deleted file mode 100644
index 42d19c5..0000000
--- a/backend/server/templates/user_details.html
+++ /dev/null
@@ -1,58 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-
-
-
Retrieve User Details
-
-
-
-
-
Update User Details
-{% endblock %}
-
-{% block script %}
-
-{% endblock %}
diff --git a/backend/server/users/adapters.py b/backend/server/users/adapters.py
new file mode 100644
index 0000000..cf0435f
--- /dev/null
+++ b/backend/server/users/adapters.py
@@ -0,0 +1,10 @@
+from allauth.account.adapter import DefaultAccountAdapter
+from django.conf import settings
+
+class NoNewUsersAccountAdapter(DefaultAccountAdapter):
+ """
+ Disable new user registration.
+ """
+ def is_open_for_signup(self, request):
+ is_disabled = getattr(settings, 'DISABLE_REGISTRATION', False)
+ return not is_disabled
\ No newline at end of file
diff --git a/backend/server/users/admin.py b/backend/server/users/admin.py
index 66d2600..4418947 100644
--- a/backend/server/users/admin.py
+++ b/backend/server/users/admin.py
@@ -1,3 +1,13 @@
from django.contrib import admin
+from allauth.account.decorators import secure_admin_login
+from django.contrib.sessions.models import Session
-# Register your models here
+admin.autodiscover()
+admin.site.login = secure_admin_login(admin.site.login)
+
+class SessionAdmin(admin.ModelAdmin):
+ def _session_data(self, obj):
+ return obj.get_decoded()
+ list_display = ['session_key', '_session_data', 'expire_date']
+
+admin.site.register(Session, SessionAdmin)
\ No newline at end of file
diff --git a/backend/server/users/backends.py b/backend/server/users/backends.py
new file mode 100644
index 0000000..8c985ce
--- /dev/null
+++ b/backend/server/users/backends.py
@@ -0,0 +1,44 @@
+from django.contrib.auth.backends import ModelBackend
+from allauth.socialaccount.models import SocialAccount
+from allauth.account.auth_backends import AuthenticationBackend as AllauthBackend
+from django.contrib.auth import get_user_model
+
+User = get_user_model()
+
+class NoPasswordAuthBackend(ModelBackend):
+ def authenticate(self, request, username=None, password=None, **kwargs):
+ # Handle allauth-specific authentication (like email login)
+ allauth_backend = AllauthBackend()
+ allauth_user = allauth_backend.authenticate(request, username=username, password=password, **kwargs)
+
+ # If allauth handled it, check our password disable logic
+ if allauth_user:
+ has_social_accounts = SocialAccount.objects.filter(user=allauth_user).exists()
+ if has_social_accounts and getattr(allauth_user, 'disable_password', False):
+ return None
+ if self.user_can_authenticate(allauth_user):
+ return allauth_user
+ return None
+
+ # Fallback to regular username/password authentication
+ if username is None or password is None:
+ return None
+
+ try:
+ # Get the user first
+ user = User.objects.get(username=username)
+ except User.DoesNotExist:
+ return None
+
+ # Check if this user has social accounts and password is disabled
+ has_social_accounts = SocialAccount.objects.filter(user=user).exists()
+
+ # If user has social accounts and disable_password is True, deny password login
+ if has_social_accounts and getattr(user, 'disable_password', False):
+ return None
+
+ # Otherwise, proceed with normal password authentication
+ if user.check_password(password) and self.user_can_authenticate(user):
+ return user
+
+ return None
\ No newline at end of file
diff --git a/backend/server/users/form_overrides.py b/backend/server/users/form_overrides.py
new file mode 100644
index 0000000..266bfd0
--- /dev/null
+++ b/backend/server/users/form_overrides.py
@@ -0,0 +1,17 @@
+from django import forms
+
+class CustomSignupForm(forms.Form):
+ first_name = forms.CharField(max_length=30, required=True)
+ last_name = forms.CharField(max_length=30, required=True)
+
+ def signup(self, request, user):
+ # Delay the import to avoid circular import
+ from allauth.account.forms import SignupForm
+
+ # No need to call super() from CustomSignupForm; use the SignupForm directly if needed
+ user.first_name = self.cleaned_data['first_name']
+ user.last_name = self.cleaned_data['last_name']
+
+ # Save the user instance
+ user.save()
+ return user
\ No newline at end of file
diff --git a/backend/server/users/forms.py b/backend/server/users/forms.py
deleted file mode 100644
index 2bb5454..0000000
--- a/backend/server/users/forms.py
+++ /dev/null
@@ -1,55 +0,0 @@
-from allauth.account.utils import (filter_users_by_email, user_pk_to_url_str, user_username)
-from allauth.utils import build_absolute_uri
-from allauth.account.adapter import get_adapter
-from allauth.account.forms import default_token_generator
-from allauth.account import app_settings
-from django.conf import settings
-
-from allauth.account.forms import ResetPasswordForm as AllAuthPasswordResetForm
-
-class CustomAllAuthPasswordResetForm(AllAuthPasswordResetForm):
-
- def clean_email(self):
- """
- Invalid email should not raise error, as this would leak users
- for unit test: test_password_reset_with_invalid_email
- """
- email = self.cleaned_data["email"]
- email = get_adapter().clean_email(email)
- self.users = filter_users_by_email(email, is_active=True)
- return self.cleaned_data["email"]
-
- def save(self, request, **kwargs):
- email = self.cleaned_data['email']
- token_generator = kwargs.get('token_generator', default_token_generator)
-
- for user in self.users:
- temp_key = token_generator.make_token(user)
-
- path = f"custom_password_reset_url/{user_pk_to_url_str(user)}/{temp_key}/"
- url = build_absolute_uri(request, path)
-
- frontend_url = settings.FRONTEND_URL
- # remove ' from frontend_url
- frontend_url = frontend_url.replace("'", "")
-
- #Values which are passed to password_reset_key_message.txt
- context = {
- "frontend_url": frontend_url,
- "user": user,
- "password_reset_url": url,
- "request": request,
- "path": path,
- "temp_key": temp_key,
- 'user_pk': user_pk_to_url_str(user),
- }
-
- if app_settings.AUTHENTICATION_METHOD != app_settings.AuthenticationMethod.EMAIL:
- context['username'] = user_username(user)
- get_adapter(request).send_mail(
- 'account/email/password_reset_key', email, context
- )
-
- return self.cleaned_data['email']
-
-
diff --git a/backend/server/users/migrations/0003_alter_customuser_email.py b/backend/server/users/migrations/0003_alter_customuser_email.py
new file mode 100644
index 0000000..7e599bc
--- /dev/null
+++ b/backend/server/users/migrations/0003_alter_customuser_email.py
@@ -0,0 +1,27 @@
+# Generated by Django 5.0.8 on 2024-11-18 14:51
+
+from django.db import migrations, models
+
+def check_duplicate_email(apps, schema_editor):
+ # sets an email to null if there are duplicates
+ CustomUser = apps.get_model('users', 'CustomUser')
+ duplicates = CustomUser.objects.values('email').annotate(email_count=models.Count('email')).filter(email_count__gt=1)
+ for duplicate in duplicates:
+ CustomUser.objects.filter(email=duplicate['email']).update(email=None)
+ print(f"Duplicate email: {duplicate['email']}")
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('users', '0002_customuser_public_profile'),
+ ]
+
+ operations = [
+ migrations.RunPython(check_duplicate_email),
+ migrations.AlterField(
+ model_name='customuser',
+ name='email',
+ field=models.EmailField(max_length=254, unique=True),
+ ),
+ ]
diff --git a/backend/server/users/migrations/0004_customuser_disable_password.py b/backend/server/users/migrations/0004_customuser_disable_password.py
new file mode 100644
index 0000000..3b11ad4
--- /dev/null
+++ b/backend/server/users/migrations/0004_customuser_disable_password.py
@@ -0,0 +1,18 @@
+# Generated by Django 5.0.8 on 2025-03-17 01:15
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('users', '0003_alter_customuser_email'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='customuser',
+ name='disable_password',
+ field=models.BooleanField(default=False),
+ ),
+ ]
diff --git a/backend/server/users/models.py b/backend/server/users/models.py
index fa28f1c..bec028f 100644
--- a/backend/server/users/models.py
+++ b/backend/server/users/models.py
@@ -4,9 +4,11 @@ from django.db import models
from django_resized import ResizedImageField
class CustomUser(AbstractUser):
+ email = models.EmailField(unique=True) # Override the email field with unique constraint
profile_pic = ResizedImageField(force_format="WEBP", quality=75, null=True, blank=True, upload_to='profile-pics/')
uuid = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)
public_profile = models.BooleanField(default=False)
+ disable_password = models.BooleanField(default=False)
def __str__(self):
return self.username
\ No newline at end of file
diff --git a/backend/server/users/serializers.py b/backend/server/users/serializers.py
index 63b5b7d..9d9bd33 100644
--- a/backend/server/users/serializers.py
+++ b/backend/server/users/serializers.py
@@ -1,26 +1,14 @@
from rest_framework import serializers
from django.contrib.auth import get_user_model
-from adventures.models import Adventure, Collection
-from users.forms import CustomAllAuthPasswordResetForm
-from dj_rest_auth.serializers import PasswordResetSerializer
-from rest_framework.exceptions import PermissionDenied
+from adventures.models import Collection
User = get_user_model()
from django.contrib.auth import get_user_model
-from django.core.exceptions import ValidationError as DjangoValidationError
from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
-try:
- from allauth.account import app_settings as allauth_account_settings
- from allauth.account.adapter import get_adapter
- from allauth.account.utils import setup_user_email
- from allauth.socialaccount.models import EmailAddress
- from allauth.utils import get_username_max_length
-except ImportError:
- raise ImportError('allauth needs to be added to INSTALLED_APPS.')
class ChangeEmailSerializer(serializers.Serializer):
new_email = serializers.EmailField(required=True)
@@ -32,102 +20,23 @@ class ChangeEmailSerializer(serializers.Serializer):
return value
-class RegisterSerializer(serializers.Serializer):
- username = serializers.CharField(
- max_length=get_username_max_length(),
- min_length=allauth_account_settings.USERNAME_MIN_LENGTH,
- required=allauth_account_settings.USERNAME_REQUIRED,
- )
- email = serializers.EmailField(required=allauth_account_settings.EMAIL_REQUIRED)
- password1 = serializers.CharField(write_only=True)
- password2 = serializers.CharField(write_only=True)
- first_name = serializers.CharField(required=False)
- last_name = serializers.CharField(required=False)
- def validate_username(self, username):
- username = get_adapter().clean_username(username)
- return username
-
- def validate_email(self, email):
- email = get_adapter().clean_email(email)
- if allauth_account_settings.UNIQUE_EMAIL:
- if email and EmailAddress.objects.is_verified(email):
- raise serializers.ValidationError(
- _('A user is already registered with this e-mail address.'),
- )
- return email
-
- def validate_password1(self, password):
- return get_adapter().clean_password(password)
-
- def validate(self, data):
- if data['password1'] != data['password2']:
- raise serializers.ValidationError(_("The two password fields didn't match."))
- return data
-
- def custom_signup(self, request, user):
- pass
-
- def get_cleaned_data(self):
- return {
- 'username': self.validated_data.get('username', ''),
- 'password1': self.validated_data.get('password1', ''),
- 'email': self.validated_data.get('email', ''),
- 'first_name': self.validated_data.get('first_name', ''),
- 'last_name': self.validated_data.get('last_name', ''),
- }
-
- def save(self, request):
- # Check if registration is disabled
- if getattr(settings, 'DISABLE_REGISTRATION', False):
- raise PermissionDenied("Registration is currently disabled.")
-
- # If registration is not disabled, proceed with the original logic
- adapter = get_adapter()
- user = adapter.new_user(request)
- self.cleaned_data = self.get_cleaned_data()
- user = adapter.save_user(request, user, self, commit=False)
- if "password1" in self.cleaned_data:
- try:
- adapter.clean_password(self.cleaned_data['password1'], user=user)
- except DjangoValidationError as exc:
- raise serializers.ValidationError(
- detail=serializers.as_serializer_error(exc)
- )
- user.save()
- self.custom_signup(request, user)
- setup_user_email(request, user, [])
- return user
from django.conf import settings
from django.contrib.auth import get_user_model
from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
UserModel = get_user_model()
-from dj_rest_auth.serializers import UserDetailsSerializer
+# from dj_rest_auth.serializers import UserDetailsSerializer
from .models import CustomUser
from rest_framework import serializers
from django.conf import settings
import os
-# class AdventureSerializer(serializers.ModelSerializer):
-# image = serializers.SerializerMethodField()
-
-# class Meta:
-# model = Adventure
-# fields = ['id', 'user_id', 'type', 'name', 'location', 'activity_types', 'description',
-# 'rating', 'link', 'image', 'date', 'trip_id', 'is_public', 'longitude', 'latitude']
-
-# def get_image(self, obj):
-# if obj.image:
-# public_url = os.environ.get('PUBLIC_URL', '')
-# return f'{public_url}/media/{obj.image.name}'
-# return None
-
class UserDetailsSerializer(serializers.ModelSerializer):
"""
- User model w/o password
+ User model without exposing the password.
"""
@staticmethod
@@ -140,8 +49,8 @@ class UserDetailsSerializer(serializers.ModelSerializer):
return username
class Meta:
+ model = CustomUser
extra_fields = ['profile_pic', 'uuid', 'public_profile']
- profile_pic = serializers.ImageField(required=False)
if hasattr(UserModel, 'USERNAME_FIELD'):
extra_fields.append(UserModel.USERNAME_FIELD)
@@ -155,19 +64,16 @@ class UserDetailsSerializer(serializers.ModelSerializer):
extra_fields.append('date_joined')
if hasattr(UserModel, 'is_staff'):
extra_fields.append('is_staff')
- if hasattr(UserModel, 'public_profile'):
- extra_fields.append('public_profile')
+ if hasattr(UserModel, 'disable_password'):
+ extra_fields.append('disable_password')
- class Meta(UserDetailsSerializer.Meta):
- model = CustomUser
- fields = UserDetailsSerializer.Meta.fields + ('profile_pic', 'uuid', 'public_profile')
-
- model = UserModel
- fields = ('pk', *extra_fields)
- read_only_fields = ('email', 'date_joined', 'is_staff', 'is_superuser', 'is_active', 'pk')
+ fields = ['pk', *extra_fields]
+ read_only_fields = ('email', 'date_joined', 'is_staff', 'is_superuser', 'is_active', 'pk', 'disable_password')
def handle_public_profile_change(self, instance, validated_data):
- """Remove user from `shared_with` if public profile is set to False."""
+ """
+ Remove user from `shared_with` if public profile is set to False.
+ """
if 'public_profile' in validated_data and not validated_data['public_profile']:
for collection in Collection.objects.filter(shared_with=instance):
collection.shared_with.remove(instance)
@@ -182,28 +88,39 @@ class UserDetailsSerializer(serializers.ModelSerializer):
class CustomUserDetailsSerializer(UserDetailsSerializer):
+ """
+ Custom serializer to add additional fields and logic for the user details.
+ """
+ has_password = serializers.SerializerMethodField()
class Meta(UserDetailsSerializer.Meta):
model = CustomUser
- fields = UserDetailsSerializer.Meta.fields + ('profile_pic', 'uuid', 'public_profile')
+ fields = UserDetailsSerializer.Meta.fields + ['profile_pic', 'uuid', 'public_profile', 'has_password', 'disable_password']
+ read_only_fields = UserDetailsSerializer.Meta.read_only_fields + ('uuid', 'has_password', 'disable_password')
+
+ @staticmethod
+ def get_has_password(instance):
+ """
+ Computes whether the user has a usable password set.
+ """
+ return instance.has_usable_password()
def to_representation(self, instance):
+ """
+ Customizes the serialized output to modify `profile_pic` URL and add computed fields.
+ """
representation = super().to_representation(instance)
+
+ # Construct profile picture URL if it exists
if instance.profile_pic:
public_url = os.environ.get('PUBLIC_URL', 'http://127.0.0.1:8000').rstrip('/')
- #print(public_url)
- # remove any ' from the url
- public_url = public_url.replace("'", "")
+ public_url = public_url.replace("'", "") # Sanitize URL
representation['profile_pic'] = f"{public_url}/media/{instance.profile_pic.name}"
+
+ # Remove `pk` field from the response
+ representation.pop('pk', None)
+ # Remove the email field
+ representation.pop('email', None)
+
return representation
-
-class MyPasswordResetSerializer(PasswordResetSerializer):
-
- def validate_email(self, value):
- # use the custom reset form
- self.reset_form = CustomAllAuthPasswordResetForm(data=self.initial_data)
- if not self.reset_form.is_valid():
- raise serializers.ValidationError(self.reset_form.errors)
-
- return value
\ No newline at end of file
diff --git a/backend/server/users/tests.py b/backend/server/users/tests.py
index 7ce503c..a529ce5 100644
--- a/backend/server/users/tests.py
+++ b/backend/server/users/tests.py
@@ -1,3 +1,82 @@
-from django.test import TestCase
+from rest_framework.test import APITestCase
+from .models import CustomUser
+from uuid import UUID
-# Create your tests here.
+from allauth.account.models import EmailAddress
+
+class UserAPITestCase(APITestCase):
+
+ def setUp(self):
+ # Signup a new user
+ response = self.client.post('/auth/browser/v1/auth/signup', {
+ 'username': 'testuser',
+ 'email': 'testuser@example.com',
+ 'password': 'testpassword',
+ 'first_name': 'Test',
+ 'last_name': 'User',
+ }, format='json')
+ self.assertEqual(response.status_code, 200)
+
+ def test_001_user(self):
+ # Fetch user metadata
+ response = self.client.get('/auth/user-metadata/', format='json')
+ self.assertEqual(response.status_code, 200)
+ data = response.json()
+ self.assertEqual(data['username'], 'testuser')
+ self.assertEqual(data['email'], 'testuser@example.com')
+ self.assertEqual(data['first_name'], 'Test')
+ self.assertEqual(data['last_name'], 'User')
+ self.assertEqual(data['public_profile'], False)
+ self.assertEqual(data['profile_pic'], None)
+ self.assertEqual(UUID(data['uuid']), CustomUser.objects.get(username='testuser').uuid)
+ self.assertEqual(data['is_staff'], False)
+ self.assertEqual(data['has_password'], True)
+
+ def test_002_user_update(self):
+ try:
+ userModel = CustomUser.objects.get(username='testuser2')
+ except:
+ userModel = None
+
+ self.assertEqual(userModel, None)
+ # Update user metadata
+ response = self.client.patch('/auth/update-user/', {
+ 'username': 'testuser2',
+ 'first_name': 'Test2',
+ 'last_name': 'User2',
+ 'public_profile': True,
+ }, format='json')
+ self.assertEqual(response.status_code, 200)
+
+ data = response.json()
+ # Note that the email field is not updated because that is a seperate endpoint
+ userModel = CustomUser.objects.get(username='testuser2')
+ self.assertEqual(data['username'], 'testuser2')
+ self.assertEqual(data['email'], 'testuser@example.com')
+ self.assertEqual(data['first_name'], 'Test2')
+ self.assertEqual(data['last_name'], 'User2')
+ self.assertEqual(data['public_profile'], True)
+ self.assertEqual(data['profile_pic'], None)
+ self.assertEqual(UUID(data['uuid']), CustomUser.objects.get(username='testuser2').uuid)
+ self.assertEqual(data['is_staff'], False)
+ self.assertEqual(data['has_password'], True)
+
+ def test_003_user_add_email(self):
+ # Update user email
+ response = self.client.post('/auth/browser/v1/account/email', {
+ 'email': 'testuser2@example.com',
+ }, format='json')
+ self.assertEqual(response.status_code, 200)
+
+ data = response.json()
+ email_data = data['data'][0]
+
+ self.assertEqual(email_data['email'], 'testuser2@example.com')
+ self.assertEqual(email_data['primary'], False)
+ self.assertEqual(email_data['verified'], False)
+
+ emails = EmailAddress.objects.filter(user=CustomUser.objects.get(username='testuser'))
+ self.assertEqual(emails.count(), 2)
+ # assert email are testuser@example and testuser2@example.com
+ self.assertEqual(emails[1].email, 'testuser@example.com')
+ self.assertEqual(emails[0].email, 'testuser2@example.com')
diff --git a/backend/server/users/views.py b/backend/server/users/views.py
index 5300d8c..d5a5a41 100644
--- a/backend/server/users/views.py
+++ b/backend/server/users/views.py
@@ -1,3 +1,4 @@
+from os import getenv
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
@@ -9,6 +10,10 @@ from django.conf import settings
from django.shortcuts import get_object_or_404
from django.contrib.auth import get_user_model
from .serializers import CustomUserDetailsSerializer as PublicUserSerializer
+from allauth.socialaccount.models import SocialApp
+from adventures.serializers import AdventureSerializer, CollectionSerializer
+from adventures.models import Adventure, Collection
+from allauth.socialaccount.models import SocialAccount
User = get_user_model()
@@ -64,6 +69,10 @@ class PublicUserListView(APIView):
for user in users:
user.email = None
serializer = PublicUserSerializer(users, many=True)
+ # for every user, remove the field has_password
+ for user in serializer.data:
+ user.pop('has_password', None)
+ user.pop('disable_password', None)
return Response(serializer.data, status=status.HTTP_200_OK)
class PublicUserDetailView(APIView):
@@ -77,9 +86,122 @@ class PublicUserDetailView(APIView):
},
operation_description="Get public user information."
)
- def get(self, request, user_id):
- user = get_object_or_404(User, uuid=user_id, public_profile=True)
+ def get(self, request, username):
+ if request.user.username == username:
+ user = get_object_or_404(User, username=username)
+ else:
+ user = get_object_or_404(User, username=username, public_profile=True)
+ serializer = PublicUserSerializer(user)
+ # for every user, remove the field has_password
+ serializer.data.pop('has_password', None)
+
# remove the email address from the response
user.email = None
+
+ # Get the users adventures and collections to include in the response
+ adventures = Adventure.objects.filter(user_id=user, is_public=True)
+ collections = Collection.objects.filter(user_id=user, is_public=True)
+ adventure_serializer = AdventureSerializer(adventures, many=True)
+ collection_serializer = CollectionSerializer(collections, many=True)
+
+ return Response({
+ 'user': serializer.data,
+ 'adventures': adventure_serializer.data,
+ 'collections': collection_serializer.data
+ }, status=status.HTTP_200_OK)
+
+class UserMetadataView(APIView):
+ permission_classes = [IsAuthenticated]
+
+ @swagger_auto_schema(
+ responses={
+ 200: openapi.Response('User metadata'),
+ 400: 'Bad Request'
+ },
+ operation_description="Get user metadata."
+ )
+ def get(self, request):
+ user = request.user
serializer = PublicUserSerializer(user)
return Response(serializer.data, status=status.HTTP_200_OK)
+
+class UpdateUserMetadataView(APIView):
+ """
+ Update user metadata using fields from the PublicUserSerializer.
+ Using patch opposed to put allows for partial updates, covers the case where it checks the username and says it's already taken. Duplicate uesrname values should not be included in the request to avoid this.
+ """
+ permission_classes = [IsAuthenticated]
+
+ @swagger_auto_schema(
+ request_body=PublicUserSerializer,
+ responses={
+ 200: openapi.Response('User metadata updated'),
+ 400: 'Bad Request'
+ },
+ operation_description="Update user metadata."
+ )
+ def patch(self, request):
+ user = request.user
+ serializer = PublicUserSerializer(user, data=request.data, partial=True, context={'request': request})
+ if serializer.is_valid():
+ serializer.save()
+ return Response(serializer.data, status=status.HTTP_200_OK)
+ return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+class EnabledSocialProvidersView(APIView):
+ """
+ Get enabled social providers for social authentication. This is used to determine which buttons to show on the frontend. Also returns a URL for each to start the authentication flow.
+ """
+
+ @swagger_auto_schema(
+ responses={
+ 200: openapi.Response('Enabled social providers'),
+ 400: 'Bad Request'
+ },
+ operation_description="Get enabled social providers."
+ )
+ def get(self, request):
+ social_providers = SocialApp.objects.filter(sites=settings.SITE_ID)
+ providers = []
+ for provider in social_providers:
+ if provider.provider == 'openid_connect':
+ new_provider = f'oidc/{provider.provider_id}'
+ else:
+ new_provider = provider.provider
+ providers.append({
+ 'provider': provider.provider,
+ 'url': f"{getenv('PUBLIC_URL')}/accounts/{new_provider}/login/",
+ 'name': provider.name
+ })
+ return Response(providers, status=status.HTTP_200_OK)
+
+
+class DisablePasswordAuthenticationView(APIView):
+ """
+ Disable password authentication for a user. This is used when a user signs up with a social provider.
+ """
+
+# Allows the user to set the disable_password field to True if they have a social account linked
+ permission_classes = [IsAuthenticated]
+
+ @swagger_auto_schema(
+ responses={
+ 200: openapi.Response('Password authentication disabled'),
+ 400: 'Bad Request'
+ },
+ operation_description="Disable password authentication."
+ )
+ def post(self, request):
+ user = request.user
+ if SocialAccount.objects.filter(user=user).exists():
+ user.disable_password = True
+ user.save()
+ return Response({"detail": "Password authentication disabled."}, status=status.HTTP_200_OK)
+ return Response({"detail": "No social account linked."}, status=status.HTTP_400_BAD_REQUEST)
+
+ def delete(self, request):
+ user = request.user
+ user.disable_password = False
+ user.save()
+ return Response({"detail": "Password authentication enabled."}, status=status.HTTP_200_OK)
+
diff --git a/backend/server/worldtravel/admin.py b/backend/server/worldtravel/admin.py
index 8c38f3f..f0d74d6 100644
--- a/backend/server/worldtravel/admin.py
+++ b/backend/server/worldtravel/admin.py
@@ -1,3 +1,5 @@
from django.contrib import admin
+from allauth.account.decorators import secure_admin_login
-# Register your models here.
+admin.autodiscover()
+admin.site.login = secure_admin_login(admin.site.login)
\ No newline at end of file
diff --git a/backend/server/worldtravel/management/commands/bulk-adventure-geocode.py b/backend/server/worldtravel/management/commands/bulk-adventure-geocode.py
new file mode 100644
index 0000000..1a5d7a5
--- /dev/null
+++ b/backend/server/worldtravel/management/commands/bulk-adventure-geocode.py
@@ -0,0 +1,26 @@
+from django.core.management.base import BaseCommand
+from adventures.models import Adventure
+import time
+
+class Command(BaseCommand):
+ help = 'Bulk geocode all adventures by triggering save on each one'
+
+ def handle(self, *args, **options):
+ adventures = Adventure.objects.all()
+ total = adventures.count()
+
+ self.stdout.write(self.style.SUCCESS(f'Starting bulk geocoding of {total} adventures'))
+
+ for i, adventure in enumerate(adventures):
+ try:
+ self.stdout.write(f'Processing adventure {i+1}/{total}: {adventure}')
+ adventure.save() # This should trigger any geocoding in the save method
+ self.stdout.write(self.style.SUCCESS(f'Successfully processed adventure {i+1}/{total}'))
+ except Exception as e:
+ self.stdout.write(self.style.ERROR(f'Error processing adventure {i+1}/{total}: {adventure} - {e}'))
+
+ # Sleep for 2 seconds between each save
+ if i < total - 1: # Don't sleep after the last one
+ time.sleep(2)
+
+ self.stdout.write(self.style.SUCCESS('Finished processing all adventures'))
diff --git a/backend/server/worldtravel/management/commands/download-countries.py b/backend/server/worldtravel/management/commands/download-countries.py
index c9dff83..5b2f48e 100644
--- a/backend/server/worldtravel/management/commands/download-countries.py
+++ b/backend/server/worldtravel/management/commands/download-countries.py
@@ -1,9 +1,13 @@
import os
from django.core.management.base import BaseCommand
import requests
-from worldtravel.models import Country, Region
+from worldtravel.models import Country, Region, City
from django.db import transaction
-import json
+import ijson
+import gc
+import tempfile
+import sqlite3
+from contextlib import contextmanager
from django.conf import settings
@@ -35,113 +39,479 @@ def saveCountryFlag(country_code):
print(f'Error downloading flag for {country_code}')
class Command(BaseCommand):
- help = 'Imports the world travel data'
+ help = 'Imports the world travel data with minimal memory usage'
- def handle(self, *args, **options):
- countries_json_path = os.path.join(settings.MEDIA_ROOT, f'countries+regions-{COUNTRY_REGION_JSON_VERSION}.json')
- if not os.path.exists(countries_json_path):
- res = requests.get(f'https://raw.githubusercontent.com/dr5hn/countries-states-cities-database/{COUNTRY_REGION_JSON_VERSION}/countries%2Bstates.json')
+ def add_arguments(self, parser):
+ parser.add_argument('--force', action='store_true', help='Force download the countries+regions+states.json file')
+ parser.add_argument('--batch-size', type=int, default=500, help='Batch size for database operations')
+
+ @contextmanager
+ def _temp_db(self):
+ """Create a temporary SQLite database for intermediate storage"""
+ with tempfile.NamedTemporaryFile(suffix='.db', delete=False) as f:
+ temp_db_path = f.name
+
+ try:
+ conn = sqlite3.connect(temp_db_path)
+ conn.execute('''CREATE TABLE temp_countries (
+ country_code TEXT PRIMARY KEY,
+ name TEXT,
+ subregion TEXT,
+ capital TEXT,
+ longitude REAL,
+ latitude REAL
+ )''')
+
+ conn.execute('''CREATE TABLE temp_regions (
+ id TEXT PRIMARY KEY,
+ name TEXT,
+ country_code TEXT,
+ longitude REAL,
+ latitude REAL
+ )''')
+
+ conn.execute('''CREATE TABLE temp_cities (
+ id TEXT PRIMARY KEY,
+ name TEXT,
+ region_id TEXT,
+ longitude REAL,
+ latitude REAL
+ )''')
+
+ conn.commit()
+ yield conn
+ finally:
+ conn.close()
+ try:
+ os.unlink(temp_db_path)
+ except OSError:
+ pass
+
+ def handle(self, **options):
+ force = options['force']
+ batch_size = options['batch_size']
+ countries_json_path = os.path.join(settings.MEDIA_ROOT, f'countries+regions+states-{COUNTRY_REGION_JSON_VERSION}.json')
+
+ # Download or validate JSON file
+ if not os.path.exists(countries_json_path) or force:
+ self.stdout.write('Downloading JSON file...')
+ res = requests.get(f'https://raw.githubusercontent.com/dr5hn/countries-states-cities-database/{COUNTRY_REGION_JSON_VERSION}/json/countries%2Bstates%2Bcities.json')
if res.status_code == 200:
with open(countries_json_path, 'w') as f:
f.write(res.text)
+ self.stdout.write(self.style.SUCCESS('JSON file downloaded successfully'))
else:
- self.stdout.write(self.style.ERROR('Error downloading countries+regions.json'))
+ self.stdout.write(self.style.ERROR('Error downloading JSON file'))
return
+ elif not os.path.isfile(countries_json_path):
+ self.stdout.write(self.style.ERROR('JSON file is not a file'))
+ return
+ elif os.path.getsize(countries_json_path) == 0:
+ self.stdout.write(self.style.ERROR('JSON file is empty'))
+ return
+ elif Country.objects.count() == 0 or Region.objects.count() == 0 or City.objects.count() == 0:
+ self.stdout.write(self.style.WARNING('Some data is missing. Re-importing all data.'))
+ else:
+ self.stdout.write(self.style.SUCCESS('Latest data already imported.'))
+ return
+
+ self.stdout.write(self.style.SUCCESS('Starting ultra-memory-efficient import process...'))
+
+ # Use temporary SQLite database for intermediate storage
+ with self._temp_db() as temp_conn:
+ self.stdout.write('Step 1: Parsing JSON and storing in temporary database...')
+ self._parse_and_store_temp(countries_json_path, temp_conn)
- with open(countries_json_path, 'r') as f:
- data = json.load(f)
+ self.stdout.write('Step 2: Processing countries...')
+ self._process_countries_from_temp(temp_conn, batch_size)
+
+ self.stdout.write('Step 3: Processing regions...')
+ self._process_regions_from_temp(temp_conn, batch_size)
+
+ self.stdout.write('Step 4: Processing cities...')
+ self._process_cities_from_temp(temp_conn, batch_size)
+
+ self.stdout.write('Step 5: Cleaning up obsolete records...')
+ self._cleanup_obsolete_records(temp_conn)
- with transaction.atomic():
- existing_countries = {country.country_code: country for country in Country.objects.all()}
- existing_regions = {region.id: region for region in Region.objects.all()}
+ self.stdout.write(self.style.SUCCESS('All data imported successfully with minimal memory usage'))
- countries_to_create = []
- regions_to_create = []
- countries_to_update = []
- regions_to_update = []
-
- processed_country_codes = set()
- processed_region_ids = set()
-
- for country in data:
+ def _parse_and_store_temp(self, json_path, temp_conn):
+ """Parse JSON once and store in temporary SQLite database"""
+ country_count = 0
+ region_count = 0
+ city_count = 0
+
+ with open(json_path, 'rb') as f:
+ parser = ijson.items(f, 'item')
+
+ for country in parser:
country_code = country['iso2']
country_name = country['name']
country_subregion = country['subregion']
country_capital = country['capital']
+ longitude = round(float(country['longitude']), 6) if country['longitude'] else None
+ latitude = round(float(country['latitude']), 6) if country['latitude'] else None
- processed_country_codes.add(country_code)
-
- if country_code in existing_countries:
- country_obj = existing_countries[country_code]
- country_obj.name = country_name
- country_obj.subregion = country_subregion
- country_obj.capital = country_capital
- countries_to_update.append(country_obj)
- else:
- country_obj = Country(
- name=country_name,
- country_code=country_code,
- subregion=country_subregion,
- capital=country_capital
- )
- countries_to_create.append(country_obj)
-
+ # Store country
+ temp_conn.execute('''INSERT OR REPLACE INTO temp_countries
+ (country_code, name, subregion, capital, longitude, latitude)
+ VALUES (?, ?, ?, ?, ?, ?)''',
+ (country_code, country_name, country_subregion, country_capital, longitude, latitude))
+
+ country_count += 1
+
+ # Download flag (do this during parsing to avoid extra pass)
saveCountryFlag(country_code)
- self.stdout.write(self.style.SUCCESS(f'Country {country_name} prepared'))
+ # Process regions/states
if country['states']:
for state in country['states']:
- name = state['name']
state_id = f"{country_code}-{state['state_code']}"
- latitude = round(float(state['latitude']), 6) if state['latitude'] else None
- longitude = round(float(state['longitude']), 6) if state['longitude'] else None
-
- processed_region_ids.add(state_id)
-
- if state_id in existing_regions:
- region_obj = existing_regions[state_id]
- region_obj.name = name
- region_obj.country = country_obj
- region_obj.longitude = longitude
- region_obj.latitude = latitude
- regions_to_update.append(region_obj)
- else:
- region_obj = Region(
- id=state_id,
- name=name,
- country=country_obj,
- longitude=longitude,
- latitude=latitude
- )
- regions_to_create.append(region_obj)
- self.stdout.write(self.style.SUCCESS(f'State {state_id} prepared'))
+ state_name = state['name']
+ state_lat = round(float(state['latitude']), 6) if state['latitude'] else None
+ state_lng = round(float(state['longitude']), 6) if state['longitude'] else None
+
+ temp_conn.execute('''INSERT OR REPLACE INTO temp_regions
+ (id, name, country_code, longitude, latitude)
+ VALUES (?, ?, ?, ?, ?)''',
+ (state_id, state_name, country_code, state_lng, state_lat))
+
+ region_count += 1
+
+ # Process cities
+ if 'cities' in state and state['cities']:
+ for city in state['cities']:
+ city_id = f"{state_id}-{city['id']}"
+ city_name = city['name']
+ city_lat = round(float(city['latitude']), 6) if city['latitude'] else None
+ city_lng = round(float(city['longitude']), 6) if city['longitude'] else None
+
+ temp_conn.execute('''INSERT OR REPLACE INTO temp_cities
+ (id, name, region_id, longitude, latitude)
+ VALUES (?, ?, ?, ?, ?)''',
+ (city_id, city_name, state_id, city_lng, city_lat))
+
+ city_count += 1
else:
+ # Country without states - create default region
state_id = f"{country_code}-00"
- processed_region_ids.add(state_id)
- if state_id in existing_regions:
- region_obj = existing_regions[state_id]
- region_obj.name = country_name
- region_obj.country = country_obj
- regions_to_update.append(region_obj)
- else:
- region_obj = Region(
- id=state_id,
- name=country_name,
- country=country_obj
- )
- regions_to_create.append(region_obj)
- self.stdout.write(self.style.SUCCESS(f'Region {state_id} prepared for {country_name}'))
+ temp_conn.execute('''INSERT OR REPLACE INTO temp_regions
+ (id, name, country_code, longitude, latitude)
+ VALUES (?, ?, ?, ?, ?)''',
+ (state_id, country_name, country_code, None, None))
+ region_count += 1
- # Bulk create new countries and regions
- Country.objects.bulk_create(countries_to_create)
- Region.objects.bulk_create(regions_to_create)
+ # Commit periodically to avoid memory buildup
+ if country_count % 100 == 0:
+ temp_conn.commit()
+ self.stdout.write(f' Parsed {country_count} countries, {region_count} regions, {city_count} cities...')
- # Bulk update existing countries and regions
- Country.objects.bulk_update(countries_to_update, ['name', 'subregion', 'capital'])
- Region.objects.bulk_update(regions_to_update, ['name', 'country', 'longitude', 'latitude'])
+ temp_conn.commit()
+ self.stdout.write(f'✓ Parsing complete: {country_count} countries, {region_count} regions, {city_count} cities')
- # Delete countries and regions that are no longer in the data
- Country.objects.exclude(country_code__in=processed_country_codes).delete()
- Region.objects.exclude(id__in=processed_region_ids).delete()
+ def _process_countries_from_temp(self, temp_conn, batch_size):
+ """Process countries from temporary database"""
+ cursor = temp_conn.execute('SELECT country_code, name, subregion, capital, longitude, latitude FROM temp_countries')
+
+ countries_to_create = []
+ countries_to_update = []
+ processed = 0
+
+ while True:
+ rows = cursor.fetchmany(batch_size)
+ if not rows:
+ break
+
+ # Batch check for existing countries
+ country_codes_in_batch = [row[0] for row in rows]
+ existing_countries = {
+ c.country_code: c for c in
+ Country.objects.filter(country_code__in=country_codes_in_batch)
+ .only('country_code', 'name', 'subregion', 'capital', 'longitude', 'latitude')
+ }
+
+ for row in rows:
+ country_code, name, subregion, capital, longitude, latitude = row
+
+ if country_code in existing_countries:
+ # Update existing
+ country_obj = existing_countries[country_code]
+ country_obj.name = name
+ country_obj.subregion = subregion
+ country_obj.capital = capital
+ country_obj.longitude = longitude
+ country_obj.latitude = latitude
+ countries_to_update.append(country_obj)
+ else:
+ countries_to_create.append(Country(
+ country_code=country_code,
+ name=name,
+ subregion=subregion,
+ capital=capital,
+ longitude=longitude,
+ latitude=latitude
+ ))
+
+ processed += 1
+
+ # Flush batches
+ if countries_to_create:
+ with transaction.atomic():
+ Country.objects.bulk_create(countries_to_create, batch_size=batch_size, ignore_conflicts=True)
+ countries_to_create.clear()
+
+ if countries_to_update:
+ with transaction.atomic():
+ Country.objects.bulk_update(
+ countries_to_update,
+ ['name', 'subregion', 'capital', 'longitude', 'latitude'],
+ batch_size=batch_size
+ )
+ countries_to_update.clear()
+
+ if processed % 1000 == 0:
+ self.stdout.write(f' Processed {processed} countries...')
+ gc.collect()
+
+ # Final flush
+ if countries_to_create:
+ with transaction.atomic():
+ Country.objects.bulk_create(countries_to_create, batch_size=batch_size, ignore_conflicts=True)
+ if countries_to_update:
+ with transaction.atomic():
+ Country.objects.bulk_update(
+ countries_to_update,
+ ['name', 'subregion', 'capital', 'longitude', 'latitude'],
+ batch_size=batch_size
+ )
+
+ self.stdout.write(f'✓ Countries complete: {processed} processed')
- self.stdout.write(self.style.SUCCESS('All data imported successfully'))
\ No newline at end of file
+ def _process_regions_from_temp(self, temp_conn, batch_size):
+ """Process regions from temporary database"""
+ # Get country mapping once
+ country_map = {c.country_code: c for c in Country.objects.only('id', 'country_code')}
+
+ cursor = temp_conn.execute('SELECT id, name, country_code, longitude, latitude FROM temp_regions')
+
+ regions_to_create = []
+ regions_to_update = []
+ processed = 0
+
+ while True:
+ rows = cursor.fetchmany(batch_size)
+ if not rows:
+ break
+
+ # Batch check for existing regions
+ region_ids_in_batch = [row[0] for row in rows]
+ existing_regions = {
+ r.id: r for r in
+ Region.objects.filter(id__in=region_ids_in_batch)
+ .select_related('country')
+ .only('id', 'name', 'country', 'longitude', 'latitude')
+ }
+
+ for row in rows:
+ region_id, name, country_code, longitude, latitude = row
+ country_obj = country_map.get(country_code)
+
+ if not country_obj:
+ continue
+
+ if region_id in existing_regions:
+ # Update existing
+ region_obj = existing_regions[region_id]
+ region_obj.name = name
+ region_obj.country = country_obj
+ region_obj.longitude = longitude
+ region_obj.latitude = latitude
+ regions_to_update.append(region_obj)
+ else:
+ regions_to_create.append(Region(
+ id=region_id,
+ name=name,
+ country=country_obj,
+ longitude=longitude,
+ latitude=latitude
+ ))
+
+ processed += 1
+
+ # Flush batches
+ if regions_to_create:
+ with transaction.atomic():
+ Region.objects.bulk_create(regions_to_create, batch_size=batch_size, ignore_conflicts=True)
+ regions_to_create.clear()
+
+ if regions_to_update:
+ with transaction.atomic():
+ Region.objects.bulk_update(
+ regions_to_update,
+ ['name', 'country', 'longitude', 'latitude'],
+ batch_size=batch_size
+ )
+ regions_to_update.clear()
+
+ if processed % 2000 == 0:
+ self.stdout.write(f' Processed {processed} regions...')
+ gc.collect()
+
+ # Final flush
+ if regions_to_create:
+ with transaction.atomic():
+ Region.objects.bulk_create(regions_to_create, batch_size=batch_size, ignore_conflicts=True)
+ if regions_to_update:
+ with transaction.atomic():
+ Region.objects.bulk_update(
+ regions_to_update,
+ ['name', 'country', 'longitude', 'latitude'],
+ batch_size=batch_size
+ )
+
+ self.stdout.write(f'✓ Regions complete: {processed} processed')
+
+ def _process_cities_from_temp(self, temp_conn, batch_size):
+ """Process cities from temporary database with optimized existence checking"""
+ # Get region mapping once
+ region_map = {r.id: r for r in Region.objects.only('id')}
+
+ cursor = temp_conn.execute('SELECT id, name, region_id, longitude, latitude FROM temp_cities')
+
+ cities_to_create = []
+ cities_to_update = []
+ processed = 0
+
+ while True:
+ rows = cursor.fetchmany(batch_size)
+ if not rows:
+ break
+
+ # Fast existence check - only get IDs, no objects
+ city_ids_in_batch = [row[0] for row in rows]
+ existing_city_ids = set(
+ City.objects.filter(id__in=city_ids_in_batch)
+ .values_list('id', flat=True)
+ )
+
+ for row in rows:
+ city_id, name, region_id, longitude, latitude = row
+ region_obj = region_map.get(region_id)
+
+ if not region_obj:
+ continue
+
+ if city_id in existing_city_ids:
+ # For updates, just store the data - we'll do bulk update by raw SQL
+ cities_to_update.append({
+ 'id': city_id,
+ 'name': name,
+ 'region_id': region_obj.id,
+ 'longitude': longitude,
+ 'latitude': latitude
+ })
+ else:
+ cities_to_create.append(City(
+ id=city_id,
+ name=name,
+ region=region_obj,
+ longitude=longitude,
+ latitude=latitude
+ ))
+
+ processed += 1
+
+ # Flush create batch (this is already fast)
+ if cities_to_create:
+ with transaction.atomic():
+ City.objects.bulk_create(cities_to_create, batch_size=batch_size, ignore_conflicts=True)
+ cities_to_create.clear()
+
+ # Flush update batch with raw SQL for speed
+ if cities_to_update:
+ self._bulk_update_cities_raw(cities_to_update)
+ cities_to_update.clear()
+
+ if processed % 5000 == 0:
+ self.stdout.write(f' Processed {processed} cities...')
+ gc.collect()
+
+ # Final flush
+ if cities_to_create:
+ with transaction.atomic():
+ City.objects.bulk_create(cities_to_create, batch_size=batch_size, ignore_conflicts=True)
+ if cities_to_update:
+ self._bulk_update_cities_raw(cities_to_update)
+
+ self.stdout.write(f'✓ Cities complete: {processed} processed')
+
+ def _bulk_update_cities_raw(self, cities_data):
+ """Fast bulk update using raw SQL"""
+ if not cities_data:
+ return
+
+ from django.db import connection
+
+ with connection.cursor() as cursor:
+ # Build the SQL for bulk update
+ # Using CASE statements for efficient bulk updates
+ when_clauses_name = []
+ when_clauses_region = []
+ when_clauses_lng = []
+ when_clauses_lat = []
+ city_ids = []
+
+ for city in cities_data:
+ city_id = city['id']
+ city_ids.append(city_id)
+ when_clauses_name.append(f"WHEN id = %s THEN %s")
+ when_clauses_region.append(f"WHEN id = %s THEN %s")
+ when_clauses_lng.append(f"WHEN id = %s THEN %s")
+ when_clauses_lat.append(f"WHEN id = %s THEN %s")
+
+ # Build parameters list
+ params = []
+ for city in cities_data:
+ params.extend([city['id'], city['name']]) # for name
+ for city in cities_data:
+ params.extend([city['id'], city['region_id']]) # for region_id
+ for city in cities_data:
+ params.extend([city['id'], city['longitude']]) # for longitude
+ for city in cities_data:
+ params.extend([city['id'], city['latitude']]) # for latitude
+ params.extend(city_ids) # for WHERE clause
+
+ # Execute the bulk update
+ sql = f"""
+ UPDATE worldtravel_city
+ SET
+ name = CASE {' '.join(when_clauses_name)} END,
+ region_id = CASE {' '.join(when_clauses_region)} END,
+ longitude = CASE {' '.join(when_clauses_lng)} END,
+ latitude = CASE {' '.join(when_clauses_lat)} END
+ WHERE id IN ({','.join(['%s'] * len(city_ids))})
+ """
+
+ cursor.execute(sql, params)
+
+ def _cleanup_obsolete_records(self, temp_conn):
+ """Clean up obsolete records using temporary database"""
+ # Get IDs from temp database to avoid loading large lists into memory
+ temp_country_codes = {row[0] for row in temp_conn.execute('SELECT country_code FROM temp_countries')}
+ temp_region_ids = {row[0] for row in temp_conn.execute('SELECT id FROM temp_regions')}
+ temp_city_ids = {row[0] for row in temp_conn.execute('SELECT id FROM temp_cities')}
+
+ with transaction.atomic():
+ countries_deleted = Country.objects.exclude(country_code__in=temp_country_codes).count()
+ regions_deleted = Region.objects.exclude(id__in=temp_region_ids).count()
+ cities_deleted = City.objects.exclude(id__in=temp_city_ids).count()
+
+ Country.objects.exclude(country_code__in=temp_country_codes).delete()
+ Region.objects.exclude(id__in=temp_region_ids).delete()
+ City.objects.exclude(id__in=temp_city_ids).delete()
+
+ if countries_deleted > 0 or regions_deleted > 0 or cities_deleted > 0:
+ self.stdout.write(f'✓ Deleted {countries_deleted} obsolete countries, {regions_deleted} regions, {cities_deleted} cities')
+ else:
+ self.stdout.write('✓ No obsolete records found to delete')
\ No newline at end of file
diff --git a/backend/server/worldtravel/migrations/0011_country_latitude_country_longitude.py b/backend/server/worldtravel/migrations/0011_country_latitude_country_longitude.py
new file mode 100644
index 0000000..8916896
--- /dev/null
+++ b/backend/server/worldtravel/migrations/0011_country_latitude_country_longitude.py
@@ -0,0 +1,23 @@
+# Generated by Django 5.0.8 on 2025-01-02 00:08
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('worldtravel', '0010_country_capital'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='country',
+ name='latitude',
+ field=models.DecimalField(blank=True, decimal_places=6, max_digits=9, null=True),
+ ),
+ migrations.AddField(
+ model_name='country',
+ name='longitude',
+ field=models.DecimalField(blank=True, decimal_places=6, max_digits=9, null=True),
+ ),
+ ]
diff --git a/backend/server/worldtravel/migrations/0012_city.py b/backend/server/worldtravel/migrations/0012_city.py
new file mode 100644
index 0000000..d14b088
--- /dev/null
+++ b/backend/server/worldtravel/migrations/0012_city.py
@@ -0,0 +1,27 @@
+# Generated by Django 5.0.8 on 2025-01-09 15:11
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('worldtravel', '0011_country_latitude_country_longitude'),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name='City',
+ fields=[
+ ('id', models.CharField(primary_key=True, serialize=False)),
+ ('name', models.CharField(max_length=100)),
+ ('longitude', models.DecimalField(blank=True, decimal_places=6, max_digits=9, null=True)),
+ ('latitude', models.DecimalField(blank=True, decimal_places=6, max_digits=9, null=True)),
+ ('region', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='worldtravel.region')),
+ ],
+ options={
+ 'verbose_name_plural': 'Cities',
+ },
+ ),
+ ]
diff --git a/backend/server/worldtravel/migrations/0013_visitedcity.py b/backend/server/worldtravel/migrations/0013_visitedcity.py
new file mode 100644
index 0000000..3b1e294
--- /dev/null
+++ b/backend/server/worldtravel/migrations/0013_visitedcity.py
@@ -0,0 +1,24 @@
+# Generated by Django 5.0.8 on 2025-01-09 17:00
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('worldtravel', '0012_city'),
+ migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name='VisitedCity',
+ fields=[
+ ('id', models.AutoField(primary_key=True, serialize=False)),
+ ('city', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='worldtravel.city')),
+ ('user_id', models.ForeignKey(default=1, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+ ],
+ ),
+ ]
diff --git a/backend/server/worldtravel/migrations/0014_alter_visitedcity_options.py b/backend/server/worldtravel/migrations/0014_alter_visitedcity_options.py
new file mode 100644
index 0000000..f2ea944
--- /dev/null
+++ b/backend/server/worldtravel/migrations/0014_alter_visitedcity_options.py
@@ -0,0 +1,17 @@
+# Generated by Django 5.0.8 on 2025-01-09 18:08
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('worldtravel', '0013_visitedcity'),
+ ]
+
+ operations = [
+ migrations.AlterModelOptions(
+ name='visitedcity',
+ options={'verbose_name_plural': 'Visited Cities'},
+ ),
+ ]
diff --git a/backend/server/worldtravel/migrations/0015_city_insert_id_country_insert_id_region_insert_id.py b/backend/server/worldtravel/migrations/0015_city_insert_id_country_insert_id_region_insert_id.py
new file mode 100644
index 0000000..5d7223b
--- /dev/null
+++ b/backend/server/worldtravel/migrations/0015_city_insert_id_country_insert_id_region_insert_id.py
@@ -0,0 +1,28 @@
+# Generated by Django 5.0.8 on 2025-01-13 17:50
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('worldtravel', '0014_alter_visitedcity_options'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='city',
+ name='insert_id',
+ field=models.UUIDField(blank=True, null=True),
+ ),
+ migrations.AddField(
+ model_name='country',
+ name='insert_id',
+ field=models.UUIDField(blank=True, null=True),
+ ),
+ migrations.AddField(
+ model_name='region',
+ name='insert_id',
+ field=models.UUIDField(blank=True, null=True),
+ ),
+ ]
diff --git a/backend/server/worldtravel/migrations/0016_remove_city_insert_id_remove_country_insert_id_and_more.py b/backend/server/worldtravel/migrations/0016_remove_city_insert_id_remove_country_insert_id_and_more.py
new file mode 100644
index 0000000..fbc07de
--- /dev/null
+++ b/backend/server/worldtravel/migrations/0016_remove_city_insert_id_remove_country_insert_id_and_more.py
@@ -0,0 +1,25 @@
+# Generated by Django 5.2.1 on 2025-06-14 17:32
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('worldtravel', '0015_city_insert_id_country_insert_id_region_insert_id'),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name='city',
+ name='insert_id',
+ ),
+ migrations.RemoveField(
+ model_name='country',
+ name='insert_id',
+ ),
+ migrations.RemoveField(
+ model_name='region',
+ name='insert_id',
+ ),
+ ]
diff --git a/backend/server/worldtravel/models.py b/backend/server/worldtravel/models.py
index f7f8f99..9e83f59 100644
--- a/backend/server/worldtravel/models.py
+++ b/backend/server/worldtravel/models.py
@@ -15,6 +15,8 @@ class Country(models.Model):
country_code = models.CharField(max_length=2, unique=True) #iso2 code
subregion = models.CharField(max_length=100, blank=True, null=True)
capital = models.CharField(max_length=100, blank=True, null=True)
+ longitude = models.DecimalField(max_digits=9, decimal_places=6, null=True, blank=True)
+ latitude = models.DecimalField(max_digits=9, decimal_places=6, null=True, blank=True)
class Meta:
verbose_name = "Country"
@@ -32,6 +34,19 @@ class Region(models.Model):
def __str__(self):
return self.name
+
+class City(models.Model):
+ id = models.CharField(primary_key=True)
+ name = models.CharField(max_length=100)
+ region = models.ForeignKey(Region, on_delete=models.CASCADE)
+ longitude = models.DecimalField(max_digits=9, decimal_places=6, null=True, blank=True)
+ latitude = models.DecimalField(max_digits=9, decimal_places=6, null=True, blank=True)
+
+ class Meta:
+ verbose_name_plural = "Cities"
+
+ def __str__(self):
+ return self.name
class VisitedRegion(models.Model):
id = models.AutoField(primary_key=True)
@@ -45,4 +60,21 @@ class VisitedRegion(models.Model):
def save(self, *args, **kwargs):
if VisitedRegion.objects.filter(user_id=self.user_id, region=self.region).exists():
raise ValidationError("Region already visited by user.")
- super().save(*args, **kwargs)
\ No newline at end of file
+ super().save(*args, **kwargs)
+
+class VisitedCity(models.Model):
+ id = models.AutoField(primary_key=True)
+ user_id = models.ForeignKey(
+ User, on_delete=models.CASCADE, default=default_user_id)
+ city = models.ForeignKey(City, on_delete=models.CASCADE)
+
+ def __str__(self):
+ return f'{self.city.name} ({self.city.region.name}) visited by: {self.user_id.username}'
+
+ def save(self, *args, **kwargs):
+ if VisitedCity.objects.filter(user_id=self.user_id, city=self.city).exists():
+ raise ValidationError("City already visited by user.")
+ super().save(*args, **kwargs)
+
+ class Meta:
+ verbose_name_plural = "Visited Cities"
\ No newline at end of file
diff --git a/backend/server/worldtravel/serializers.py b/backend/server/worldtravel/serializers.py
index e3f7010..962914b 100644
--- a/backend/server/worldtravel/serializers.py
+++ b/backend/server/worldtravel/serializers.py
@@ -1,6 +1,8 @@
import os
-from .models import Country, Region, VisitedRegion
+from .models import Country, Region, VisitedRegion, City, VisitedCity
from rest_framework import serializers
+from main.utils import CustomModelSerializer
+
class CountrySerializer(serializers.ModelSerializer):
def get_public_url(self, obj):
@@ -19,21 +21,41 @@ class CountrySerializer(serializers.ModelSerializer):
return Region.objects.filter(country=obj).count()
def get_num_visits(self, obj):
- return VisitedRegion.objects.filter(region__country=obj).count()
+ request = self.context.get('request')
+ user = getattr(request, 'user', None)
+
+ if user and user.is_authenticated:
+ return VisitedRegion.objects.filter(region__country=obj, user_id=user).count()
+
+ return 0
class Meta:
model = Country
fields = '__all__'
- read_only_fields = ['id', 'name', 'country_code', 'subregion', 'flag_url', 'num_regions', 'num_visits']
+ read_only_fields = ['id', 'name', 'country_code', 'subregion', 'flag_url', 'num_regions', 'num_visits', 'longitude', 'latitude', 'capital']
class RegionSerializer(serializers.ModelSerializer):
+ num_cities = serializers.SerializerMethodField()
+ country_name = serializers.CharField(source='country.name', read_only=True)
class Meta:
model = Region
fields = '__all__'
- read_only_fields = ['id', 'name', 'country', 'longitude', 'latitude']
+ read_only_fields = ['id', 'name', 'country', 'longitude', 'latitude', 'num_cities', 'country_name']
-class VisitedRegionSerializer(serializers.ModelSerializer):
+ def get_num_cities(self, obj):
+ return City.objects.filter(region=obj).count()
+
+class CitySerializer(serializers.ModelSerializer):
+ region_name = serializers.CharField(source='region.name', read_only=True)
+ country_name = serializers.CharField(source='region.country.name', read_only=True
+ )
+ class Meta:
+ model = City
+ fields = '__all__'
+ read_only_fields = ['id', 'name', 'region', 'longitude', 'latitude', 'region_name', 'country_name']
+
+class VisitedRegionSerializer(CustomModelSerializer):
longitude = serializers.DecimalField(source='region.longitude', max_digits=9, decimal_places=6, read_only=True)
latitude = serializers.DecimalField(source='region.latitude', max_digits=9, decimal_places=6, read_only=True)
name = serializers.CharField(source='region.name', read_only=True)
@@ -41,4 +63,14 @@ class VisitedRegionSerializer(serializers.ModelSerializer):
class Meta:
model = VisitedRegion
fields = ['id', 'user_id', 'region', 'longitude', 'latitude', 'name']
+ read_only_fields = ['user_id', 'id', 'longitude', 'latitude', 'name']
+
+class VisitedCitySerializer(CustomModelSerializer):
+ longitude = serializers.DecimalField(source='city.longitude', max_digits=9, decimal_places=6, read_only=True)
+ latitude = serializers.DecimalField(source='city.latitude', max_digits=9, decimal_places=6, read_only=True)
+ name = serializers.CharField(source='city.name', read_only=True)
+
+ class Meta:
+ model = VisitedCity
+ fields = ['id', 'user_id', 'city', 'longitude', 'latitude', 'name']
read_only_fields = ['user_id', 'id', 'longitude', 'latitude', 'name']
\ No newline at end of file
diff --git a/backend/server/worldtravel/urls.py b/backend/server/worldtravel/urls.py
index 46fe197..f28beda 100644
--- a/backend/server/worldtravel/urls.py
+++ b/backend/server/worldtravel/urls.py
@@ -2,15 +2,17 @@
from django.urls import include, path
from rest_framework.routers import DefaultRouter
-from .views import CountryViewSet, RegionViewSet, VisitedRegionViewSet, regions_by_country, visits_by_country
-
+from .views import CountryViewSet, RegionViewSet, VisitedRegionViewSet, regions_by_country, visits_by_country, cities_by_region, VisitedCityViewSet, visits_by_region
router = DefaultRouter()
router.register(r'countries', CountryViewSet, basename='countries')
router.register(r'regions', RegionViewSet, basename='regions')
router.register(r'visitedregion', VisitedRegionViewSet, basename='visitedregion')
+router.register(r'visitedcity', VisitedCityViewSet, basename='visitedcity')
urlpatterns = [
path('', include(router.urls)),
path('
/regions/', regions_by_country, name='regions-by-country'),
- path('/visits/', visits_by_country, name='visits-by-country')
+ path('/visits/', visits_by_country, name='visits-by-country'),
+ path('regions//cities/', cities_by_region, name='cities-by-region'),
+ path('regions//cities/visits/', visits_by_region, name='visits-by-region'),
]
diff --git a/backend/server/worldtravel/views.py b/backend/server/worldtravel/views.py
index 8e38261..c77309d 100644
--- a/backend/server/worldtravel/views.py
+++ b/backend/server/worldtravel/views.py
@@ -1,6 +1,6 @@
from django.shortcuts import render
-from .models import Country, Region, VisitedRegion
-from .serializers import CountrySerializer, RegionSerializer, VisitedRegionSerializer
+from .models import Country, Region, VisitedRegion, City, VisitedCity
+from .serializers import CitySerializer, CountrySerializer, RegionSerializer, VisitedRegionSerializer, VisitedCitySerializer
from rest_framework import viewsets, status
from rest_framework.permissions import IsAuthenticated
from django.shortcuts import get_object_or_404
@@ -33,6 +33,23 @@ def visits_by_country(request, country_code):
serializer = VisitedRegionSerializer(visits, many=True)
return Response(serializer.data)
+@api_view(['GET'])
+@permission_classes([IsAuthenticated])
+def cities_by_region(request, region_id):
+ region = get_object_or_404(Region, id=region_id)
+ cities = City.objects.filter(region=region).order_by('name')
+ serializer = CitySerializer(cities, many=True)
+ return Response(serializer.data)
+
+@api_view(['GET'])
+@permission_classes([IsAuthenticated])
+def visits_by_region(request, region_id):
+ region = get_object_or_404(Region, id=region_id)
+ visits = VisitedCity.objects.filter(city__region=region, user_id=request.user.id)
+
+ serializer = VisitedCitySerializer(visits, many=True)
+ return Response(serializer.data)
+
class CountryViewSet(viewsets.ReadOnlyModelViewSet):
queryset = Country.objects.all().order_by('name')
serializer_class = CountrySerializer
@@ -59,7 +76,6 @@ class CountryViewSet(viewsets.ReadOnlyModelViewSet):
for adventure in adventures:
if adventure.latitude is not None and adventure.longitude is not None:
try:
- print(f"Adventure {adventure.id}: lat={adventure.latitude}, lon={adventure.longitude}")
point = Point(float(adventure.longitude), float(adventure.latitude), srid=4326)
region = Region.objects.filter(geometry__contains=point).first()
if region:
@@ -94,4 +110,46 @@ class VisitedRegionViewSet(viewsets.ModelViewSet):
serializer.is_valid(raise_exception=True)
self.perform_create(serializer)
headers = self.get_success_headers(serializer.data)
- return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
\ No newline at end of file
+ return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
+
+ def destroy(self, request, **kwargs):
+ # delete by region id
+ region = get_object_or_404(Region, id=kwargs['pk'])
+ visited_region = VisitedRegion.objects.filter(user_id=request.user.id, region=region)
+ if visited_region.exists():
+ visited_region.delete()
+ return Response(status=status.HTTP_204_NO_CONTENT)
+ else:
+ return Response({"error": "Visited region not found."}, status=status.HTTP_404_NOT_FOUND)
+
+class VisitedCityViewSet(viewsets.ModelViewSet):
+ serializer_class = VisitedCitySerializer
+ permission_classes = [IsAuthenticated]
+
+ def get_queryset(self):
+ return VisitedCity.objects.filter(user_id=self.request.user.id)
+
+ def perform_create(self, serializer):
+ serializer.save(user_id=self.request.user)
+
+ def create(self, request, *args, **kwargs):
+ request.data['user_id'] = request.user
+ serializer = self.get_serializer(data=request.data)
+ serializer.is_valid(raise_exception=True)
+ self.perform_create(serializer)
+ # if the region is not visited, visit it
+ region = serializer.validated_data['city'].region
+ if not VisitedRegion.objects.filter(user_id=request.user.id, region=region).exists():
+ VisitedRegion.objects.create(user_id=request.user, region=region)
+ headers = self.get_success_headers(serializer.data)
+ return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
+
+ def destroy(self, request, **kwargs):
+ # delete by city id
+ city = get_object_or_404(City, id=kwargs['pk'])
+ visited_city = VisitedCity.objects.filter(user_id=request.user.id, city=city)
+ if visited_city.exists():
+ visited_city.delete()
+ return Response(status=status.HTTP_204_NO_CONTENT)
+ else:
+ return Response({"error": "Visited city not found."}, status=status.HTTP_404_NOT_FOUND)
\ No newline at end of file
diff --git a/backend/supervisord.conf b/backend/supervisord.conf
new file mode 100644
index 0000000..e7adec7
--- /dev/null
+++ b/backend/supervisord.conf
@@ -0,0 +1,16 @@
+[supervisord]
+nodaemon=true
+
+[program:nginx]
+command=/usr/sbin/nginx -g "daemon off;"
+autorestart=true
+stdout_logfile=/dev/stdout
+stderr_logfile=/dev/stderr
+
+[program:gunicorn]
+command=/code/entrypoint.sh
+autorestart=true
+stdout_logfile=/dev/stdout
+stderr_logfile=/dev/stderr
+stdout_logfile_maxbytes = 0
+stderr_logfile_maxbytes = 0
diff --git a/brand/adventurelog.png b/brand/adventurelog.png
new file mode 100644
index 0000000..21325e5
Binary files /dev/null and b/brand/adventurelog.png differ
diff --git a/brand/adventurelog.svg b/brand/adventurelog.svg
new file mode 100644
index 0000000..92667f2
--- /dev/null
+++ b/brand/adventurelog.svg
@@ -0,0 +1,313 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/brand/banner.png b/brand/banner.png
new file mode 100644
index 0000000..a0dd0ae
Binary files /dev/null and b/brand/banner.png differ
diff --git a/brand/screenshots/adventures.png b/brand/screenshots/adventures.png
new file mode 100644
index 0000000..96204df
Binary files /dev/null and b/brand/screenshots/adventures.png differ
diff --git a/brand/screenshots/countries.png b/brand/screenshots/countries.png
new file mode 100644
index 0000000..6eecc59
Binary files /dev/null and b/brand/screenshots/countries.png differ
diff --git a/brand/screenshots/dashboard.png b/brand/screenshots/dashboard.png
new file mode 100644
index 0000000..05ca982
Binary files /dev/null and b/brand/screenshots/dashboard.png differ
diff --git a/brand/screenshots/details.png b/brand/screenshots/details.png
new file mode 100644
index 0000000..47c99fa
Binary files /dev/null and b/brand/screenshots/details.png differ
diff --git a/brand/screenshots/edit.png b/brand/screenshots/edit.png
new file mode 100644
index 0000000..1fce199
Binary files /dev/null and b/brand/screenshots/edit.png differ
diff --git a/brand/screenshots/itinerary.png b/brand/screenshots/itinerary.png
new file mode 100644
index 0000000..c11cf4e
Binary files /dev/null and b/brand/screenshots/itinerary.png differ
diff --git a/brand/screenshots/map.png b/brand/screenshots/map.png
new file mode 100644
index 0000000..081cb79
Binary files /dev/null and b/brand/screenshots/map.png differ
diff --git a/brand/screenshots/regions.png b/brand/screenshots/regions.png
new file mode 100644
index 0000000..4aea537
Binary files /dev/null and b/brand/screenshots/regions.png differ
diff --git a/cdn/.gitignore b/cdn/.gitignore
new file mode 100644
index 0000000..adbb97d
--- /dev/null
+++ b/cdn/.gitignore
@@ -0,0 +1 @@
+data/
\ No newline at end of file
diff --git a/cdn/Dockerfile b/cdn/Dockerfile
new file mode 100644
index 0000000..f47e79a
--- /dev/null
+++ b/cdn/Dockerfile
@@ -0,0 +1,36 @@
+# Use an official Python image as a base
+FROM python:3.11-slim
+
+# Set the working directory
+WORKDIR /app
+
+# Install required Python packages
+RUN pip install --no-cache-dir requests osm2geojson
+
+# Copy the script into the container
+COPY main.py /app/main.py
+
+# Run the script to generate the data folder and GeoJSON files (this runs inside the container)
+RUN python -u /app/main.py
+
+# Install Nginx
+RUN apt update && apt install -y nginx && rm -rf /var/lib/apt/lists/*
+
+# Copy the entire generated data folder to the Nginx serving directory
+RUN mkdir -p /var/www/html/data && cp -r /app/data/* /var/www/html/data/
+
+# Copy Nginx configuration
+COPY nginx.conf /etc/nginx/nginx.conf
+
+# Copy the index.html file to the Nginx serving directory
+COPY index.html /usr/share/nginx/html/index.html
+
+# Expose port 80 for Nginx
+EXPOSE 80
+
+# Copy the entrypoint script into the container
+COPY entrypoint.sh /app/entrypoint.sh
+RUN chmod +x /app/entrypoint.sh
+
+# Set the entrypoint script as the default command
+ENTRYPOINT ["/app/entrypoint.sh"]
diff --git a/cdn/README.md b/cdn/README.md
new file mode 100644
index 0000000..f935c14
--- /dev/null
+++ b/cdn/README.md
@@ -0,0 +1,3 @@
+This folder contains the scripts to generate AdventureLOG CDN files.
+
+Special thanks to [@larsl-net](https://github.com/larsl-net) for the GeoJSON generation script.
diff --git a/cdn/docker-compose.yml b/cdn/docker-compose.yml
new file mode 100644
index 0000000..5699dd8
--- /dev/null
+++ b/cdn/docker-compose.yml
@@ -0,0 +1,9 @@
+services:
+ cdn:
+ build: .
+ container_name: adventurelog-cdn
+ ports:
+ - "8080:80"
+ restart: unless-stopped
+ volumes:
+ - ./data:/app/data # Ensures new data files persist
diff --git a/cdn/entrypoint.sh b/cdn/entrypoint.sh
new file mode 100644
index 0000000..fffe244
--- /dev/null
+++ b/cdn/entrypoint.sh
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# Any setup tasks or checks can go here (if needed)
+echo "AdventureLog CDN has started!"
+echo "Refer to the documentation for information about connecting your AdventureLog instance to this CDN."
+echo "Thanks to our data providers for making this possible! You can find them on the CDN site."
+
+# Start Nginx in the foreground (as the main process)
+nginx -g 'daemon off;'
diff --git a/cdn/index.html b/cdn/index.html
new file mode 100644
index 0000000..7b78153
--- /dev/null
+++ b/cdn/index.html
@@ -0,0 +1,90 @@
+
+
+
+ AdventureLog CDN
+
+
+
Welcome to the AdventureLog CDN
+
+ This is a content delivery network for the AdventureLog project. You
+ can browse the content by clicking the button below.
+
+
Browse Content
+
+
+
About AdventureLog
+
+ AdventureLog is a project that aims to provide a platform for users to
+ log their adventures and share them with the world. The project is
+ developed by Sean Morley and is
+ open source. View it on GitHub here:
+ AdventureLog .
+
+
+
+
+
+
+
Data Attributions
+
+ The data provided in this CDN is sourced from the following
+ repositories:
+
+
+
+
+
+
yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/documentation/babel.config.js b/documentation/babel.config.js
deleted file mode 100644
index e00595d..0000000
--- a/documentation/babel.config.js
+++ /dev/null
@@ -1,3 +0,0 @@
-module.exports = {
- presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};
diff --git a/documentation/blog/authors.yml b/documentation/blog/authors.yml
deleted file mode 100644
index bcb2991..0000000
--- a/documentation/blog/authors.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-endi:
- name: Endilie Yacop Sucipto
- title: Maintainer of Docusaurus
- url: https://github.com/endiliey
- image_url: https://github.com/endiliey.png
-
-yangshun:
- name: Yangshun Tay
- title: Front End Engineer @ Facebook
- url: https://github.com/yangshun
- image_url: https://github.com/yangshun.png
-
-slorber:
- name: Sébastien Lorber
- title: Docusaurus maintainer
- url: https://sebastienlorber.com
- image_url: https://github.com/slorber.png
diff --git a/documentation/blog/tags.yml b/documentation/blog/tags.yml
deleted file mode 100644
index f71dd73..0000000
--- a/documentation/blog/tags.yml
+++ /dev/null
@@ -1,16 +0,0 @@
-facebook:
- label: Facebook
- permalink: /facebook
- description: Facebook tag description
-hello:
- label: Hello
- permalink: /hello
- description: Hello tag description
-docusaurus:
- label: Docusaurus
- permalink: /docusaurus
- description: Docusaurus tag description
-hola:
- label: Hola
- permalink: /hola
- description: Hola tag description
diff --git a/documentation/docs/Configuration/_category_.json b/documentation/docs/Configuration/_category_.json
deleted file mode 100644
index bfdff8e..0000000
--- a/documentation/docs/Configuration/_category_.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "label": "Configuration ⚙️",
- "position": 3,
- "link": {
- "type": "generated-index",
- "description": "Options for AdventureLog settings."
- }
-}
diff --git a/documentation/docs/Configuration/email_backend.md b/documentation/docs/Configuration/email_backend.md
deleted file mode 100644
index a8cb1d2..0000000
--- a/documentation/docs/Configuration/email_backend.md
+++ /dev/null
@@ -1,28 +0,0 @@
----
-sidebar_position: 2
----
-
-# Change Email Backend
-
-To change the email backend, you can set the following variable in your docker-compose.yml under the server service:
-
-## Using Console (default)
-
-```yaml
-environment:
- - EMAIL_BACKEND='console'
-```
-
-## With SMTP
-
-```yaml
-environment:
- - EMAIL_BACKEND='email'
- - EMAIL_HOST='smtp.gmail.com'
- - EMAIL_USE_TLS=False
- - EMAIL_PORT=587
- - EMAIL_USE_SSL=True
- - EMAIL_HOST_USER='user'
- - EMAIL_HOST_PASSWORD='password'
- - DEFAULT_FROM_EMAIL='user@example.com'
-```
diff --git a/documentation/docs/Configuration/img/docsVersionDropdown.png b/documentation/docs/Configuration/img/docsVersionDropdown.png
deleted file mode 100644
index 97e4164..0000000
Binary files a/documentation/docs/Configuration/img/docsVersionDropdown.png and /dev/null differ
diff --git a/documentation/docs/Configuration/img/localeDropdown.png b/documentation/docs/Configuration/img/localeDropdown.png
deleted file mode 100644
index e257edc..0000000
Binary files a/documentation/docs/Configuration/img/localeDropdown.png and /dev/null differ
diff --git a/documentation/docs/Guides/_category_.json b/documentation/docs/Guides/_category_.json
deleted file mode 100644
index 29c6469..0000000
--- a/documentation/docs/Guides/_category_.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "label": "Guides 📚",
- "position": 4,
- "link": {
- "type": "generated-index",
- "description": "Guides for AdventureLog."
- }
-}
diff --git a/documentation/docs/Installation/_category_.json b/documentation/docs/Installation/_category_.json
deleted file mode 100644
index fd67cf3..0000000
--- a/documentation/docs/Installation/_category_.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "label": "Installation 🖥️",
- "position": 2,
- "link": {
- "type": "generated-index",
- "description": "How to get AdventureLog installed and setup."
- }
-}
diff --git a/documentation/docs/Installation/docker.md b/documentation/docs/Installation/docker.md
deleted file mode 100644
index 9c2fa2b..0000000
--- a/documentation/docs/Installation/docker.md
+++ /dev/null
@@ -1,59 +0,0 @@
----
-sidebar_position: 1
----
-
-# Docker 🐋
-
-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.
-
-## Prerequisites
-
-- Docker installed on your machine/server. You can learn how to download it [here](https://docs.docker.com/engine/install/).
-
-## Getting Started
-
-Get the `docker-compose.yml` file from the AdventureLog repository. You can download it from [here](https://github.com/seanmorley15/AdventureLog/blob/main/docker-compose.yml) or run this command to download it directly to your machine:
-
-```bash
-wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/docker-compose.yml
-```
-
-## Configuration
-
-Here is a summary of the configuration options available in the `docker-compose.yml` file:
-
-
-
-### Frontend Container (web)
-
-| 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:8015 |
-| `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 |
-
-### Backend Container (server)
-
-| 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. | admin@example.com |
-| `PUBLIC_URL` | Yes | This needs to match the outward port of the server and be accessible from where the app is used. It is used for the creation of image urls. | 'http://localhost:8016' |
-| `CSRF_TRUSTED_ORIGINS` | Yes | Need to be changed to the orgins where you use your backend server and frontend. These values are comma seperated. | http://localhost:8016 |
-| `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:8015' |
-
-## Running the Containers
-
-To start the containers, run the following command:
-
-```bash
-docker compose up -d
-```
-
-Enjoy AdventureLog! 🎉
diff --git a/documentation/docs/TERMS_&_PRIVACY.md b/documentation/docs/TERMS_&_PRIVACY.md
deleted file mode 100644
index f0381e8..0000000
--- a/documentation/docs/TERMS_&_PRIVACY.md
+++ /dev/null
@@ -1,76 +0,0 @@
-# Terms and Privacy Policy
-
-**This document only applies to the demo version of AdventureLog hosted on adventurelog.app. If you are using a self-hosted version of AdventureLog, you are responsible for creating and maintaining your own terms and privacy policy and the terms of the GPL-3.0 license apply.**
-
-### Terms and Conditions for AdventureLog
-
-#### 1. **Introduction**
-
-Welcome to AdventureLog ("App"). By using this App, you agree to comply with and be bound by the following terms and conditions ("Terms"). Please review these Terms carefully before using the App. If you do not agree with these Terms, you should not use the App.
-
-#### 2. **License**
-
-This App is provided as open-source software under the GPL-3.0 license. By using this App, you acknowledge that the App is provided on an "AS IS" basis without warranties of any kind, either express or implied. The demo version of the App is offered for testing and development purposes only.
-
-#### 3. **No Warranty**
-
-The App, including the demo version, is provided "as is" without any representations or warranties, express or implied. The use of the App is at your own risk. We do not warrant that the App will be error-free or that access to the App will be uninterrupted.
-
-#### 4. **Limitation of Liability**
-
-To the fullest extent permitted by law, AdventureLog and its developers shall not be liable for any indirect, incidental, special, consequential, or punitive damages, or any loss of data, use, or profit, arising out of or in connection with your use of or inability to use the App. This includes, but is not limited to, any damage to your device, data, or other materials.
-
-#### 5. **User Responsibility**
-
-You are solely responsible for the use of the App and any consequences thereof. The App is provided for educational and testing purposes in its demo form. You agree to use the App responsibly and in compliance with all applicable laws.
-
-#### 6. **Modifications to the Terms**
-
-We reserve the right to modify these Terms at any time. Any changes will be posted to this page, and your continued use of the App following such changes constitutes acceptance of the new Terms.
-
-#### 7. **Termination**
-
-We may terminate or suspend access to the App immediately, without prior notice or liability, for any reason whatsoever, including but not limited to a breach of the Terms.
-
-#### 8. **Governing Law**
-
-These Terms shall be governed by and construed in accordance with the laws of the United States of America. Any disputes arising from these Terms shall be subject to the exclusive jurisdiction of the courts in the United States.
-
----
-
-### Privacy Policy for AdventureLog
-
-#### 1. **Introduction**
-
-This Privacy Policy outlines how AdventureLog ("we," "us," or "our") collects, uses, and protects any information that you provide when using the demo version of the AdventureLog ("App").
-
-#### 2. **Information We Collect**
-
-- User profile information: We may collect your name, email address, and other information you provide when creating an account. This information is used to identify you as a user of the App.
-- Adventure data: We collect data related to your adventures, including locations, photos, and notes. This is essential for the functionality of the App.
-
-**Bottom line**: _We collect only the information necessary to provide the services of the App and do not share it with third parties._
-
-#### 3. **Use of Collected Information**
-
-Any technical information collected will be used solely for the purpose of improving the App and ensuring its functionality. We do not sell, rent, or lease your data to third parties.
-
-#### 4. **Data Security**
-
-We are committed to ensuring that your information is secure. However, please be aware that no method of transmission over the internet, or method of electronic storage, is 100% secure, and we cannot guarantee the absolute security of your data.
-
-#### 5. **Third-Party Services**
-
-The demo version of the App may include third-party services or links to external sites. We are not responsible for the privacy practices or content of these third-party services. Please review their privacy policies before using their services.
-
-#### 6. **Children's Privacy**
-
-The App is not intended for use by anyone under the age of 13, and we do not knowingly collect personal data from children.
-
-#### 7. **Changes to This Privacy Policy**
-
-We reserve the right to update this Privacy Policy at any time. Any changes will be posted on this page, and your continued use of the App following such changes constitutes acceptance of the new Privacy Policy.
-
-#### 8. **Contact Us**
-
-If you have any questions about this Privacy Policy, please contact us at contact@adventurelog.app
diff --git a/documentation/docs/Usage/_category_.json b/documentation/docs/Usage/_category_.json
deleted file mode 100644
index 7594506..0000000
--- a/documentation/docs/Usage/_category_.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "label": "Usage ✈️",
- "position": 3,
- "link": {
- "type": "generated-index",
- "description": "How to use AdventureLog."
- }
-}
diff --git a/documentation/docs/Usage/img/docsVersionDropdown.png b/documentation/docs/Usage/img/docsVersionDropdown.png
deleted file mode 100644
index 97e4164..0000000
Binary files a/documentation/docs/Usage/img/docsVersionDropdown.png and /dev/null differ
diff --git a/documentation/docs/Usage/img/localeDropdown.png b/documentation/docs/Usage/img/localeDropdown.png
deleted file mode 100644
index e257edc..0000000
Binary files a/documentation/docs/Usage/img/localeDropdown.png and /dev/null differ
diff --git a/documentation/docs/changelogs/v0-10-0.md b/documentation/docs/changelogs/v0-10-0.md
new file mode 100644
index 0000000..8ecba82
--- /dev/null
+++ b/documentation/docs/changelogs/v0-10-0.md
@@ -0,0 +1,123 @@
+# AdventureLog v0.10.0 - Trip Maps, Google Maps Integration & Quick Deploy Script
+
+Released 06-10-2025
+
+Hi everyone,
+
+I’m pleased to share **AdventureLog v0.10.0**, a focused update that brings timezone-aware planning, smoother maps, and simpler deployment. This release refines many of the core features you’ve been using and addresses feedback from the community. Thank you for your contributions, suggestions, and ongoing support!
+
+## 🧭 Time-Aware Travel Planning
+
+**Timezone-Aware Visits & Timeline Logic**
+
+- Exact start/end times with timezones for each visit, so your itinerary matches when and where events actually happen.
+- Collections now auto-order by date, giving your timeline a clear, chronological flow.
+- Lodging and transportation entries follow the same rules, making multi-city trips easier to visualize.
+- A chronologically accurate map and timeline view shows your adventure in the right order.
+
+## 🗺️ Smart Mapping & Location Tools
+
+**Google Maps Integration (Optional)**
+
+- Autocomplete-powered location search (via Google Maps) for faster, more accurate entries.
+- Automatic geocoding ties new or updated adventures to the correct country, region, and city.
+- Improved map performance and cleaner markers throughout the app.
+
+**Map Interaction Enhancements**
+
+- Open any adventure location in Apple Maps, Google Maps, or OpenStreetMap with one click.
+- Full-width maps on mobile devices for better visibility.
+- Tidied-up markers and updated category icons for clarity.
+
+## 🎨 UI & UX Refinements
+
+- Updated adventure forms with clearer labels and streamlined inputs.
+- Smoother page transitions and consistent layouts on desktop and mobile.
+- Design and spacing adjustments for a more balanced, polished appearance.
+- Various bug fixes to address layout quirks and improve overall usability.
+
+## 🌍 Localization & Navigation
+
+- Expanded language support and updated locale files.
+- Improved back/forward navigation so you don’t lose your place when browsing collections.
+- Responsive collection cards that adapt to different screen sizes.
+- Fixed minor layout issues related to collections and navigation.
+
+## 📷 Immich Integration Upgrades
+
+- Choose whether to copy Immich images into AdventureLog storage or reference them via URL to avoid duplicating files.
+- Toggle “Copy Images” on or off to manage storage preferences.
+- Updated logic to prevent duplicate image uploads when using Immich.
+
+## ⚙️ DevOps & Backend Enhancements
+
+- Switched to `supervisord` in Docker for reliable container startup and centralized logging.
+- Restored IPv6 support for dual-stack deployments.
+- Upgraded to Node.js v22 for better performance and compatibility.
+- Added more tests, improved UTC-aware date validation, and refined ID generation.
+- Optimized database migrations for smoother updates.
+
+## 📘 Documentation & Community Resources
+
+- New guide for deploying with Caddy web server, covering TLS setup and reverse proxy configuration.
+- Updated instructions for Google Maps integration, including API key setup and troubleshooting.
+- Follow our Mastodon profile at [@adventurelog@mastodon.social](https://mastodon.social/@adventurelog) for updates and discussion.
+- Chat with other users on our [Discord server](https://discord.gg/wRbQ9Egr8C) to share feedback, ask questions, or swap travel tips.
+
+## ✨ NEW: Quick Deploy Script
+
+Based on community feedback, we’ve added a simple deployment script:
+
+1. Run:
+
+ ```bash
+ curl -sSL https://get.adventurelog.app | bash
+ ```
+
+2. Provide your domain/ip details when prompted.
+ The script handles Docker Compose, and environment configuration automatically.
+
+Self-hosting just got a bit easier—no more manual setup steps.
+
+## ℹ️ Additional Notes
+
+- **Bulk Geocoding**
+ To geocode existing adventures in one go docker exec into the backend container and run:
+
+ ```
+ python manage.py bulk-adventure-geocode
+ ```
+
+ This will link all adventures to their correct country, region, and city.
+
+- **Timezone Migrations**
+ If you have older trips without explicit timezones, simply view a trip’s detail page and AdventureLog will auto-convert the dates.
+
+## 👥 Thanks to Our Contributors
+
+Your pull requests, issue reports, and ongoing feedback have been instrumental. Special thanks to:
+
+- @ClumsyAdmin
+- @eidsheim98
+- @andreatitolo
+- @lesensei
+- @theshaun
+- @lkiesow
+- @larsl-net
+- @marcschumacher
+
+Every contribution helps make AdventureLog more reliable and user-friendly.
+
+## 💖 Support the Project
+
+If you find AdventureLog helpful, consider sponsoring me! Your support keeps this project going:
+
+[https://seanmorley.com/sponsor](https://seanmorley.com/sponsor)
+
+📖 [View the Full Changelog on GitHub](https://github.com/seanmorley15/AdventureLog/compare/v0.9.0...v0.10.0)
+
+Thanks for being part of the AdventureLog community. I appreciate your feedback and look forward to seeing where your next journey takes you!
+
+Happy travels,
+**Sean Morley** (@seanmorley15)
+Project Lead, AdventureLog
diff --git a/documentation/docs/changelogs/v0-7-0.md b/documentation/docs/changelogs/v0-7-0.md
new file mode 100644
index 0000000..f6be73e
--- /dev/null
+++ b/documentation/docs/changelogs/v0-7-0.md
@@ -0,0 +1,50 @@
+# AdventureLog v0.7.0
+
+Released 10-15-2024
+
+Hi everyone! I am super excited to announce AdventureLog v0.7.0! This is one of the biggest updates I have ever released and I am super happy its finally ready for all of you to enjoy. The majority of this update is based around community feedback and ideas which is awesome!
+
+# What's New
+
+### Adventures 📍
+
+- Adventures can now be visited multiple times by adding a new visit.
+ - Existing adventure dates will be automatically migrated to this new format
+- Adventures now use categories for organization.
+- A new adventure creation/edit modal simplifies the process and has a cleaner overall design with dropdown menus.
+
+### Collections 🍱
+
+- **Collections can now be shared with other public users for collaboration!**
+- Collections now have a link field so you can attach things like photo albums right to your collection.
+
+### World Travel 🗺️
+
+- The World Travel dataset now includes **every ISO defined country and region**. It is based off of a new dataset [dr5hn/countries-states-cities-database](https://github.com/dr5hn/countries-states-cities-database). Searching for countries is now supported. Capitals and world regions are now listed on the country card.
+
+### Profiles 👥
+
+- Users can now toggle their profile to be public. This allows other users to share collections with them for collaboration.
+
+### Bug Fixes 🐛
+
+- Fixed bug where collection dates during daylight savings time would cause errors in date placement
+- Fixed login issue with usernames of different cases
+
+### Other
+
+- New logo for AdventureLog! Thanks @redtechtiger!
+- Releases now include a multi-arch image like pushes to main
+- Docker compose file now has more comments for clarity
+- New Aesthetic Dark theme (its my favorite by far)
+
+# Sponsorship 💖
+
+[](https://www.buymeacoffee.com/seanmorley15)
+As a computer science student, I pour my free time into developing and enhancing AdventureLog, driven by my passion for this project and its potential to make adventure planning easier for everyone. Your support, no matter the amount, means the world to me. It shows that you believe in the project and its future. I’m excited to announce that I’ve launched my page on Buy Me A Coffee—check it out!
+
+Hope you all enjoy!
+Feel free to join the release discussion below to share feedback and ideas or anything else related to this update!
+
+Happy travels,
+Sean @seanmorley15
diff --git a/documentation/docs/changelogs/v0-7-1.md b/documentation/docs/changelogs/v0-7-1.md
new file mode 100644
index 0000000..54aef56
--- /dev/null
+++ b/documentation/docs/changelogs/v0-7-1.md
@@ -0,0 +1,59 @@
+# AdventureLog v0.7.1
+
+Released 11-13-2024
+
+Hi everyone! I am super excited to announce the release of AdventureLog v0.7.1. This update includes a lot of improvements that make using AdventureLog more enjoyable and accessible. This update is largely community driven as it addresses more than 10 enhancement requests (thanks everyone!).
+
+# What's New ✨
+
+### Docker Compose Change 🐋
+
+> [!IMPORTANT]
+> _While the app will still function normally without these changes_, they are recommended for the best support and stability
+> The **migration guide** can be found here: https://docs.adventurelog.app/docs/Guides/nginx_migration
+
+- Migrated nginx inside of server container for easier deployment, removed external nginx requirement
+- App now uses gunicorn for better performance at scale
+
+### Adventures 📍
+
+- Adventures can now be sorted by visit status (visited or planned) on the adventures screen.
+- The Adventure create/edit modal now supports reverse geocoding locations. This means that for most places, the location field will be auto filled when you click on the map. It now has a popup of the associated world travel region and allows you to mark the region as visited if its not already. This makes it easier to track your world region visits!
+- The adventure map now shows previews of images and has the emoji of the category on the map pin!
+- In settings, you can perform a visited region check. This will scan all of your visited adventures and mark the associated world travel region as visited if its detected in the adventure. This serves as a bulk operation for for existing adventures.
+
+### World Travel 🗺️
+
+- World travel regions can now be sorted by world regions and visit status. The statuses are fully visited, partially visited, and not visited.
+
+### Bug Fixes 🐛
+
+- Fixed a bug where sorting by date would return to home screen
+
+### Localization 🌐
+
+- Migrated app to a localization framework
+- Added toggle for languages on the `...` menu in the top right.
+- **Supported Languages**: English, Spanish, French, German, Italian, Chinese, Dutch, Swedish
+
+### Other
+
+- New login and signup screen featuring adventures from community members (submitted in discord server).
+
+## What's Next ⏭️
+
+- Custom categories for adventures
+- Ability to link adventures to multiple collections
+- MFA and ODIC auth
+- Immich integration
+
+# Sponsorship 💖
+
+[](https://www.buymeacoffee.com/seanmorley15)
+As a computer science student, I pour my free time into developing and enhancing AdventureLog, driven by my passion for this project and its potential to make adventure planning easier for everyone. Your support, no matter the amount, means the world to me. It shows that you believe in the project and its future. I’m excited to announce that I’ve launched my page on Buy Me A Coffee—check it out!
+
+Hope you all enjoy!
+Feel free to join the release discussion below to share feedback and ideas or anything else related to this update!
+
+Happy travels,
+Sean @seanmorley15
diff --git a/documentation/docs/changelogs/v0-8-0.md b/documentation/docs/changelogs/v0-8-0.md
new file mode 100644
index 0000000..90f6e43
--- /dev/null
+++ b/documentation/docs/changelogs/v0-8-0.md
@@ -0,0 +1,105 @@
+# AdventureLog v0.8.0 - Immich Integration, Calendar and Customization
+
+Released 01-08-2025
+
+Hi everyone! 🚀
+I’m thrilled to announce the release of **AdventureLog v0.8.0**, a huge update packed with new features, improvements, and enhancements. This release focuses on delivering a better user experience, improved functionality, and expanded customization options. Let’s dive into what’s new!
+
+---
+
+## What's New ✨
+
+### Immich Integration
+
+- AdventureLog now integrates seamlessly with [Immich](https://github.com/immich-app), the amazing self-hostable photo library.
+- Import your photos from Immich directly into AdventureLog adventures and collections.
+ - Use Immich Smart Search to search images to import based on natural queries.
+ - Sort by photo album to easily import your trips photos to an adventure.
+
+### 🚗 Transportation
+
+- **New Transportation Edit Modal**: Includes detailed origin and destination location information for better trip planning.
+- **Autocomplete for Airport Codes**: Quickly find and add airport codes while planning transportation.
+- **New Transportation Card Design**: Redesigned for better clarity and aesthetics.
+
+---
+
+### 📝 Notes and Checklists
+
+- **New Modals for Notes and Checklists**: Simplified creation and editing of your notes and checklists.
+- **Delete Confirmation**: Added a confirmation step when deleting notes, checklists, or transportation to prevent accidental deletions.
+
+---
+
+### 📍Adventures
+
+- **Markdown Editor and Preview**: Write and format adventure descriptions with a markdown editor.
+- **Custom Categories**: Organize your adventures with personalized categories and icons.
+- **Primary Images**: Adventure images can now be marked as the "primary image" and will be the first one to be displayed in adventure views.
+
+---
+
+### 🗓️ Calendar
+
+- **Calendar View**: View your adventures and transportation in a calendar layout.
+- **ICS File Export**: Export your calendar as an ICS file for use with external apps like Google Calendar or Outlook.
+
+---
+
+### 🌐 Localization
+
+- Added support for **Polish** language (@dymek37).
+- Improved Swedish language data (@nordtechtiger)
+
+---
+
+### 🔒 Authentication
+
+- **New Authentication System**: Includes MFA for added security.
+- **Admin Page Authentication**: Enhanced protection for admin operations.
+ > [!IMPORTANT]
+ > Ensure you know your credentials as you will be signed out after updating!
+
+---
+
+### 🖌️ UI & Theming
+
+- **Nord Theme**: A sleek new theme option for a modern and clean interface.
+- **New Home Dashboard**: A revamped dashboard experience to access everything you need quickly and view your travel stats.
+
+---
+
+### ⚙️ Settings
+
+- **Overhauled Settings Page**: Redesigned for better navigation and usability.
+
+---
+
+### 🐛 Bug Fixes and Improvements
+
+- Fixed the **NGINX Upload Size Bug**: Upload larger files without issues.
+- **Prevents Duplicate Emails**: Improved account management; users can now add multiple emails to a single account.
+- General **code cleanliness** for better performance and stability.
+- Fixes Django Admin access through Traefik (@PascalBru)
+
+---
+
+### 🌐 Infrastructure
+
+- Added **Kubernetes Configurations** for scalable deployments (@MaximUltimatum).
+- Launched a **New [Documentation Site](https://adventurelog.app)** for better guidance and support.
+
+---
+
+## Sponsorship 💖
+
+[](https://www.buymeacoffee.com/seanmorley15)
+As always, AdventureLog continues to grow thanks to your incredible support and feedback. If you love using the app and want to help shape its future, consider supporting me on **Buy Me A Coffee**. Your contributions go a long way in allowing for AdventureLog to continue to improve and thrive 😊
+
+---
+
+Enjoy the update! 🎉
+Feel free to share your feedback, ideas, or questions in the discussion below or on the official [discord server](https://discord.gg/wRbQ9Egr8C)!
+
+Happy travels,
+**Sean Morley** (@seanmorley15)
diff --git a/documentation/docs/changelogs/v0-9-0.md b/documentation/docs/changelogs/v0-9-0.md
new file mode 100644
index 0000000..18764ee
--- /dev/null
+++ b/documentation/docs/changelogs/v0-9-0.md
@@ -0,0 +1,133 @@
+# AdventureLog v0.9.0 - Smart Recommendations, Attachments, and Maps
+
+Released 03-19-2025
+
+Hi travelers! 🌍
+I’m excited to unveil **AdventureLog v0.9.0**, one of our most feature-packed updates yet! From Smart Recommendations to enhanced maps and a refreshed profile system, this release is all about improving your travel planning and adventure tracking experience. Let’s dive into what’s new!
+
+---
+
+## What's New ✨
+
+### 🧠 Smart Recommendations
+
+- **AdventureLog Smart Recommendations**: Get tailored suggestions for new adventures and activities based on your collection destinations.
+- Leverages OpenStreetMap to recommend places and activities near your travel destinations.
+
+---
+
+### 🗂️ Attachments, GPX Maps & Global Search
+
+- **Attachments System**: Attach files to your adventures to view key trip data like maps and tickets in AdventureLog!
+- **GPX File Uploads & Maps**: Upload GPX tracks to adventures to visualize them directly on your maps.
+- **Global Search**: A universal search bar to quickly find adventures, cities, countries, and more across your instance.
+
+---
+
+### 🏨 Lodging & Itinerary
+
+- **Lodging Tracking**: Add and manage lodging accommodations as part of your collections, complete with check-in/check-out dates.
+- **Improved Itinerary Views**: Better day-by-day itinerary display with clear UI enhancements.
+
+---
+
+### 🗺️ Maps & Locations
+
+- **Open Locations in Maps**: Directly open adventure locations and points of interest in your preferred mapping service.
+- **Adventure Category Icons on Maps**: View custom category icons right on your adventure and collection maps.
+
+---
+
+### 🗓️ Calendar
+
+- **Collection Range View**: Improved calendar view showing the full date range of collections.
+
+---
+
+### 🌐 Authentication & Security
+
+- **OIDC Authentication**: Added support for OpenID Connect (OIDC) for seamless integration with identity providers.
+- **Secure Session Cookies**: Improved session cookie handling with dynamic domain detection and better security for IP addresses.
+- **Disable Password Auth**: Option to disable password auth for users with connected OIDC/Social accounts.
+
+---
+
+### 🖥️ PWA Support
+
+- **Progressive Web App (PWA) Support**: Install AdventureLog as a PWA on your desktop or mobile device for a native app experience.
+
+---
+
+### 🏗️ Infrastructure & DevOps
+
+- **Dual-Stack Backend**: IPv4 and IPv6 ready backend system (@larsl-net).
+- **Kubernetes Configs** continue to be improved for scalable deployments.
+
+---
+
+### 🌐 Localization
+
+- **Korean language support** (@seanmorley15).
+- **Improved Dutch** (@ThomasDetemmerman), **Simplified Chinese** (@jyyyeung), **German** (@Cathnan and @marcschumacher) translations.
+- **Polish and Swedish** translations improved in prior release!
+
+---
+
+### 📝 Documentation
+
+- **New Unraid Installation Guide** with community-contributed updates (@ThunderLord956, @evertyang).
+- Updated **OIDC** and **Immich integration** docs for clarity (@UndyingSoul, @motox986).
+- General spell-check and documentation polish (@ThunderLord956, @mcguirepr89).
+
+---
+
+### 🐛 Bug Fixes and Improvements
+
+- Fixed CSRF issues with admin tools.
+- Backend ready for **dual-stack** environments.
+- Improved itinerary element display and GPX file handling.
+- Optimized session cookie handling for domain/IP setups.
+- Various **small Python fixes** (@larsl-net).
+- Fixed container relations (@bucherfa).
+- Django updated to **5.0.11** for security and performance improvements.
+- General **codebase clean-up** and UI polish.
+
+---
+
+## 🌟 New Contributors
+
+A huge shoutout to our amazing new contributors! 🎉
+
+- @larsl-net
+- @bucherfa
+- @UndyingSoul
+- @ThunderLord956
+- @evertyang
+- @Thiesjoo
+- @motox986
+- @mcguirepr89
+- @ThomasDetemmerman
+- @Cathnan
+- @jyyyeung
+- @marcschumacher
+
+Thank you for helping AdventureLog grow! 🙌
+
+---
+
+## Support My Work 💖
+
+[](https://www.buymeacoffee.com/seanmorley15)
+If AdventureLog has made your travels more organized or your trip memories richer, consider supporting my work on **Buy Me A Coffee**. Your support directly helps shape the future of this project! ☕
+
+---
+
+Enjoy this update and keep sharing your journeys with us! 🌍✈️
+As always, drop your feedback and ideas in the [official Discord](https://discord.gg/wRbQ9Egr8) or in the discussions!
+
+Happy travels,
+**Sean Morley** (@seanmorley15)
+
+---
+
+**[Full Changelog](https://github.com/seanmorley15/AdventureLog/compare/v0.8.0...v0.9.0)**
diff --git a/documentation/docs/Configuration/umami_analytics.md b/documentation/docs/configuration/analytics.md
similarity index 94%
rename from documentation/docs/Configuration/umami_analytics.md
rename to documentation/docs/configuration/analytics.md
index 6407e35..82dd4bc 100644
--- a/documentation/docs/Configuration/umami_analytics.md
+++ b/documentation/docs/configuration/analytics.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 3
----
-
# Umami Analytics (optional)
Umami Analytics is a free, open-source, and privacy-focused web analytics tool that can be used as an alternative to Google Analytics. Learn more about Umami Analytics [here](https://umami.is/).
diff --git a/documentation/docs/Configuration/disable_registration.md b/documentation/docs/configuration/disable_registration.md
similarity index 92%
rename from documentation/docs/Configuration/disable_registration.md
rename to documentation/docs/configuration/disable_registration.md
index 5313476..d749521 100644
--- a/documentation/docs/Configuration/disable_registration.md
+++ b/documentation/docs/configuration/disable_registration.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 1
----
-
# Disable Registration
To disable registration, you can set the following variable in your docker-compose.yml under the server service:
diff --git a/documentation/docs/configuration/email.md b/documentation/docs/configuration/email.md
new file mode 100644
index 0000000..52a3a20
--- /dev/null
+++ b/documentation/docs/configuration/email.md
@@ -0,0 +1,34 @@
+# Change Email Backend
+
+To change the email backend, you can set the following variable in your docker-compose.yml under the server service:
+
+## Using Console (default)
+
+```yaml
+environment:
+ - EMAIL_BACKEND=console
+```
+
+## With SMTP
+
+```yaml
+environment:
+ - EMAIL_BACKEND=email
+ - EMAIL_HOST=smtp.gmail.com
+ - EMAIL_USE_TLS=True
+ - EMAIL_PORT=587
+ - EMAIL_USE_SSL=False
+ - EMAIL_HOST_USER=user
+ - EMAIL_HOST_PASSWORD=password
+ - DEFAULT_FROM_EMAIL=user@example.com
+```
+
+## Customizing Emails
+
+By default, the email will display `[example.com]` in the subject. You can customize this in the admin site.
+
+1. Go to the admin site (serverurl/admin)
+2. Click on `Sites`
+3. Click on first site, it will probably be `example.com`
+4. Change the `Domain name` and `Display name` to your desired values
+5. Click `Save`
diff --git a/documentation/docs/configuration/google_maps_integration.md b/documentation/docs/configuration/google_maps_integration.md
new file mode 100644
index 0000000..2618d12
--- /dev/null
+++ b/documentation/docs/configuration/google_maps_integration.md
@@ -0,0 +1,36 @@
+# Google Maps Integration
+
+To enable Google Maps integration in AdventureLog, you'll need to create a Google Maps API key. This key allows AdventureLog to use Google Maps services such as geocoding and location search throughout the application.
+
+Follow the steps below to generate your own API key:
+
+## Google Cloud Console Setup
+
+1. Go to the [Google Cloud Console](https://console.cloud.google.com/).
+2. Create an account if you don't have one in order to access the console.
+3. Click on the project dropdown in the top bar.
+4. Click **New Project**.
+5. Name your project (e.g., `AdventureLog Maps`) and click **Create**.
+6. Once the project is created, ensure it is selected in the project dropdown.
+7. Click on the **Navigation menu** (three horizontal lines in the top left corner).
+8. Navigate to **Google Maps Platform**.
+9. Once in the Maps Platform, click on **Keys & Credentials** in the left sidebar.
+10. Click on **Create credentials** and select **API key**.
+11. A dialog will appear with your new API key. Copy this key for later use.
+
+
+
+## Configuration in AdventureLog
+
+Set the API key in your environment file or configuration under the backend service of AdventureLog. This is typically done in the `docker-compose.yml` file or directly in your environment variables `.env` file.
+
+```env
+GOOGLE_MAPS_API_KEY=your_api_key_here
+```
+
+Once this is set, AdventureLog will be able to utilize Google Maps services for geocoding and location searches instead of relying on the default OpenStreetMap services.
diff --git a/documentation/docs/configuration/immich_integration.md b/documentation/docs/configuration/immich_integration.md
new file mode 100644
index 0000000..1581e42
--- /dev/null
+++ b/documentation/docs/configuration/immich_integration.md
@@ -0,0 +1,28 @@
+# Immich Integration
+
+### What is Immich?
+
+
+
+
+
+Immich is a self-hosted, open-source platform that allows users to backup and manage their photos and videos similar to Google Photos, but with the advantage of storing data on their own private server, ensuring greater privacy and control over their media.
+
+- [Immich Website and Documentation](https://immich.app/)
+- [GitHub Repository](https://github.com/immich-app/immich)
+
+### How to integrate Immich with AdventureLog?
+
+To integrate Immich with AdventureLog, you need to have an Immich server running and accessible from where AdventureLog is running.
+
+1. Obtain the Immich API Key from the Immich server.
+ - In the Immich web interface, click on your user profile picture, go to `Account Settings` > `API Keys`.
+ - Click `New API Key` and name it something like `AdventureLog`.
+ - Copy the generated API Key, you will need it in the next step.
+2. Go to the AdventureLog web interface, click on your user profile picture, go to `Settings` and scroll down to the `Immich Integration` section.
+ - Enter the URL of your Immich server, e.g. `https://immich.example.com/api`. Note that `localhost` or `127.0.0.1` will probably not work because Immich and AdventureLog are running on different docker networks. It is recommended to use the IP address of the server where Immich is running ex `http://my-server-ip:port` or a domain name.
+ - Paste the API Key you obtained in the previous step.
+ - Click `Enable Immich` to save the settings.
+3. Now, when you are adding images to an adventure, you will see an option to search for images in Immich or upload from an album.
+
+Enjoy the privacy and control of managing your travel media with Immich and AdventureLog! 🎉
diff --git a/documentation/docs/configuration/social_auth.md b/documentation/docs/configuration/social_auth.md
new file mode 100644
index 0000000..9d4a231
--- /dev/null
+++ b/documentation/docs/configuration/social_auth.md
@@ -0,0 +1,16 @@
+# Social Authentication
+
+AdventureLog support authentication via 3rd party services and self-hosted identity providers. Once these services are enabled, users can log in to AdventureLog using their accounts from these services and link existing AdventureLog accounts to these services for easier access.
+
+The steps for each service varies so please refer to the specific service's documentation for more information.
+
+## Supported Services
+
+- [Authentik](social_auth/authentik.md) (self-hosted)
+- [GitHub](social_auth/github.md)
+- [Open ID Connect](social_auth/oidc.md)
+- [Authelia](https://www.authelia.com/integration/openid-connect/adventure-log/)
+
+## Linking Existing Accounts
+
+If you already have an AdventureLog account and would like to link it to a 3rd party service, you can do so by logging in to AdventureLog and navigating to the `Account Settings` page. From there, scroll down to `Social and OIDC Authentication` and click the `Launch Account Connections` button. If identity providers have been enabled on your instance, you will see a list of available services to link to.
diff --git a/documentation/docs/configuration/social_auth/authentik.md b/documentation/docs/configuration/social_auth/authentik.md
new file mode 100644
index 0000000..ff57ac3
--- /dev/null
+++ b/documentation/docs/configuration/social_auth/authentik.md
@@ -0,0 +1,70 @@
+# Authentik OIDC Authentication
+
+/accounts/oidc/.*$` where `` is the URL of your AdventureLog Server service.
+5. Copy the `Client ID` and `Client Secret` generated by Authentik, you will need these to configure AdventureLog.
+6. Create an application in Authentik and assign the provider to it, name the `slug` `adventurelog` or any other name you prefer.
+7. If you want the logo, you can find it [here](https://adventurelog.app/adventurelog.png).
+
+### AdventureLog Configuration
+
+This configuration is done in the [Admin Panel](../../guides/admin_panel.md). You can either launch the panel directly from the `Settings` page or navigate to `/admin` on your AdventureLog server.
+
+1. Login to AdventureLog as an administrator and navigate to the `Settings` page.
+2. Scroll down to the `Administration Settings` and launch the admin panel.
+3. In the admin panel, navigate to the `Social Accounts` section and click the add button next to `Social applications`. Fill in the following fields:
+
+ - Provider: `OpenID Connect`
+ - Provider ID: Authentik Client ID
+ - Name: `Authentik`
+ - Client ID: Authentik Client ID
+ - Secret Key: Authentik Client Secret
+ - Key: can be left blank
+ - Settings: (make sure http/https is set correctly)
+
+ ```json
+ {
+ "server_url": "http:///application/o/[YOUR_SLUG]/"
+ }
+ ```
+
+ ::: warning
+ `localhost` is most likely not a valid `server_url` for Authentik in this instance because `localhost` is the server running AdventureLog, not Authentik. You should use the IP address of the server running Authentik or the domain name if you have one.
+
+- Sites: move over the sites you want to enable Authentik on, usually `example.com` and `www.example.com` unless you renamed your sites.
+
+#### What it Should Look Like
+
+
+
+4. Save the configuration.
+
+Ensure that the Authentik server is running and accessible by AdventureLog. Users should now be able to log in to AdventureLog using their Authentik account.
+
+## Linking to Existing Account
+
+If a user has an existing AdventureLog account and wants to link it to their Authentik account, they can do so by logging in to their AdventureLog account and navigating to the `Settings` page. There is a button that says `Launch Account Connections`, click that and then choose the provider to link to the existing account.
+
+## Troubleshooting
+
+### 404 error when logging in.
+
+Ensure the `/accounts` path is routed to the backend, as it shouldn't hit the frontend when it's properly configured.
+
+### Authentik - No Permission
+
+In the Authentik instance, check access to the AdventureLog application from a specific user by using the Check Access/Test button on the Application dashboard. If the user doesn't have access, you can add an existing user/group policy to give your specific user/group access to the AdventureLog application.
diff --git a/documentation/docs/configuration/social_auth/github.md b/documentation/docs/configuration/social_auth/github.md
new file mode 100644
index 0000000..51efb74
--- /dev/null
+++ b/documentation/docs/configuration/social_auth/github.md
@@ -0,0 +1,49 @@
+# GitHub Social Authentication
+
+AdventureLog can be configured to use GitHub as an identity provider for social authentication. Users can then log in to AdventureLog using their GitHub account.
+
+# Configuration
+
+To enable GitHub as an identity provider, the administrator must first configure GitHub to allow AdventureLog to authenticate users.
+
+### GitHub Configuration
+
+1. Visit the GitHub OAuth Apps Settings page at [https://github.com/settings/developers](https://github.com/settings/developers).
+2. Click on `New OAuth App`.
+3. Fill in the following fields:
+
+ - Application Name: `AdventureLog` or any other name you prefer.
+ - Homepage URL: `` where `` is the URL of your AdventureLog Frontend service.
+ - Application Description: `AdventureLog` or any other description you prefer.
+ - Authorization callback URL: `http:///accounts/github/login/callback/` where `` is the URL of your AdventureLog Backend service.
+ - If you want the logo, you can find it [here](https://adventurelog.app/adventurelog.png).
+
+### AdventureLog Configuration
+
+This configuration is done in the [Admin Panel](../../guides/admin_panel.md). You can either launch the panel directly from the `Settings` page or navigate to `/admin` on your AdventureLog server.
+
+1. Login to AdventureLog as an administrator and navigate to the `Settings` page.
+2. Scroll down to the `Administration Settings` and launch the admin panel.
+3. In the admin panel, navigate to the `Social Accounts` section and click the add button next to `Social applications`. Fill in the following fields:
+
+ - Provider: `GitHub`
+ - Provider ID: GitHub Client ID
+ - Name: `GitHub`
+ - Client ID: GitHub Client ID
+ - Secret Key: GitHub Client Secret
+ - Key: can be left blank
+ - Settings: can be left blank
+ - Sites: move over the sites you want to enable Authentik on, usually `example.com` and `www.example.com` unless you renamed your sites.
+
+4. Save the configuration.
+
+Users should now be able to log in to AdventureLog using their GitHub account, and link it to existing accounts.
+
+## Linking to Existing Account
+
+If a user has an existing AdventureLog account and wants to link it to their Github account, they can do so by logging in to their AdventureLog account and navigating to the `Settings` page. There is a button that says `Launch Account Connections`, click that and then choose the provider to link to the existing account.
+
+#### What it Should Look Like
+
+
+
diff --git a/documentation/docs/configuration/social_auth/oidc.md b/documentation/docs/configuration/social_auth/oidc.md
new file mode 100644
index 0000000..0b0384d
--- /dev/null
+++ b/documentation/docs/configuration/social_auth/oidc.md
@@ -0,0 +1,7 @@
+# OIDC Social Authentication
+
+AdventureLog can be configured to use OpenID Connect (OIDC) as an identity provider for social authentication. Users can then log in to AdventureLog using their OIDC account.
+
+The configuration is basically the same as [Authentik](./authentik.md), but you replace the client and secret with the OIDC client and secret provided by your OIDC provider. The `server_url` should be the URL of your OIDC provider where you can find the OIDC configuration.
+
+Each provider has a different configuration, so you will need to check the documentation of your OIDC provider to find the correct configuration.
diff --git a/documentation/docs/Usage/updating.md b/documentation/docs/configuration/updating.md
similarity index 82%
rename from documentation/docs/Usage/updating.md
rename to documentation/docs/configuration/updating.md
index 5e265da..85fec59 100644
--- a/documentation/docs/Usage/updating.md
+++ b/documentation/docs/configuration/updating.md
@@ -1,10 +1,6 @@
----
-sidebar_position: 1
----
-
# Updating
-Updating AdventureLog when using docker can be quite easy. Run the folowing commands to pull the latest version and restart the containers. Make sure you backup your instance before updating just in case!
+Updating AdventureLog when using docker can be quite easy. Run the following commands to pull the latest version and restart the containers. Make sure you backup your instance before updating just in case!
Note: Make sure you are in the same directory as your `docker-compose.yml` file.
@@ -24,5 +20,5 @@ docker exec -it bash
Once you are in the container run the following command to resync the region data.
```bash
-python manage.py download-countries
+python manage.py download-countries --force
```
diff --git a/documentation/docs/guides/admin_panel.md b/documentation/docs/guides/admin_panel.md
new file mode 100644
index 0000000..bd13d66
--- /dev/null
+++ b/documentation/docs/guides/admin_panel.md
@@ -0,0 +1,11 @@
+# AdventureLog Admin Panel
+
+The AdventureLog Admin Panel, powered by Django, is a web-based interface that allows administrators to manage objects in the AdventureLog database. The Admin Panel is accessible at the `/admin` endpoint of the AdventureLog server. Example: `https://al-server.yourdomain.com/admin`.
+
+Features of the Admin Panel include:
+
+- **User Management**: Administrators can view and manage user accounts, including creating new users, updating user information, and deleting users.
+- **Adventure Management**: Administrators can view and manage adventures, including creating new adventures, updating adventure information, and deleting adventures.
+- **Security**: The Admin Panel enforces access control to ensure that only authorized administrators can access and manage the database. This means that only users with the `is_staff` flag set to `True` can access the Admin Panel.
+
+Note: the `CSRF_TRUSTED_ORIGINS` setting in your `docker-compose.yml` file must include the domain of the server. For example, if your server is hosted at `https://al-server.yourdomain.com`, you should add `al-server.yourdomain.com` to the `CSRF_TRUSTED_ORIGINS` setting.
diff --git a/documentation/docs/Guides/nginx_migration.md b/documentation/docs/guides/v0-7-1_migration.md
similarity index 87%
rename from documentation/docs/Guides/nginx_migration.md
rename to documentation/docs/guides/v0-7-1_migration.md
index 2a5032c..77aaeaf 100644
--- a/documentation/docs/Guides/nginx_migration.md
+++ b/documentation/docs/guides/v0-7-1_migration.md
@@ -1,14 +1,10 @@
----
-sidebar_position: 2
----
-
# AdventureLog v0.7.1 Migration
-In order to make installation easier, the AdventureLog v0.7.1 release has **removed the need for a seperate nginx container** and cofig to serve the media files. Instead, the media files are now served by an instance of nginx running in the same container as the Django application.
+In order to make installation easier, the AdventureLog v0.7.1 release has **removed the need for a separate nginx container** and config to serve the media files. Instead, the media files are now served by an instance of nginx running in the same container as the Django application.
## Docker Compose Changes
-:::note
+::: tip
You can also just use the new `docker-compose.yml` file in the repository and change the environment variables to match your setup.
@@ -17,15 +13,19 @@ You can also just use the new `docker-compose.yml` file in the repository and ch
1. Remove the `nginx` service from your `docker-compose.yml` file.
2. Update the `PUBLIC_URL` environment variable in the `server` service (backend) to match the address of your **server**, instead of the previous nginx instance. For example, if your server is exposed to `http://localhost:8000`, set `PUBLIC_URL` to `http://localhost:8000`. If you are using a domain name, set `PUBLIC_URL` to `https://api.yourdomain.com` as an example.
3. Change port mapping for the `server` service. Right now it probably looks like this:
+
```yaml
ports:
- "your-exposed-port:8000"
```
+
Change it to:
+
```yaml
ports:
- "your-exposed-port:80"
```
+
This is because the nginx instance in the container is now serving the Django application on port 80. The port on the left side of the colon is the port on your host machine and this can be changed to whatever you want. The port on the right side of the colon is the port the Django application is running on in the container and should not be changed.
That's it! You should now be able to run the application with the new configuration! This update also includes some performance enhancements so there should be a slight speed increase as well, especially with multiple users.
diff --git a/documentation/docs/install/caddy.md b/documentation/docs/install/caddy.md
new file mode 100644
index 0000000..d9d088a
--- /dev/null
+++ b/documentation/docs/install/caddy.md
@@ -0,0 +1,67 @@
+# Installation with Caddy
+
+Caddy is a modern HTTP reverse proxy. It automatically integrates with Let's Encrypt (or other certificate providers) to generate TLS certificates for your site.
+
+As an example, if you want to add Caddy to your Docker compose configuration, add the following service to your `docker-compose.yml`:
+
+```yaml
+services:
+ caddy:
+ image: docker.io/library/caddy:2
+ container_name: adventurelog-caddy
+ restart: unless-stopped
+ cap_add:
+ - NET_ADMIN
+ ports:
+ - "80:80"
+ - "443:443"
+ - "443:443/udp"
+ volumes:
+ - ./caddy:/etc/caddy
+ - caddy_data:/data
+ - caddy_config:/config
+
+ web: ...
+ server: ...
+ db: ...
+
+volumes:
+ caddy_data:
+ caddy_config:
+```
+
+Since all ingress traffic to the AdventureLog containsers now travels through Caddy, we can also remove the external ports configuration from those containsers in the `docker-compose.yml`. Just delete this configuration:
+
+```yaml
+ web:
+ ports:
+ - "8016:80"
+…
+ server:
+ ports:
+ - "8015:3000"
+```
+
+That's it for the Docker compose changes. Of course, there are other methods to run Caddy which are equally valid.
+
+However, we also need to configure Caddy. For this, create a file `./caddy/Caddyfile` in which you configure the requests which are proxied to the frontend and backend respectively and what domain Caddy should request a certificate for:
+
+```
+adventurelog.example.com {
+
+ @frontend {
+ not path /media* /admin* /static* /accounts*
+ }
+ reverse_proxy @frontend web:3000
+
+ reverse_proxy server:80
+}
+```
+
+Once configured, you can start up the containsers:
+
+```bash
+docker compose up
+```
+
+Your AdventureLog should now be up and running.
diff --git a/documentation/docs/install/docker.md b/documentation/docs/install/docker.md
new file mode 100644
index 0000000..b698502
--- /dev/null
+++ b/documentation/docs/install/docker.md
@@ -0,0 +1,82 @@
+# Docker 🐋
+
+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.
+
+## Prerequisites
+
+- Docker installed on your machine/server. You can learn how to download it [here](https://docs.docker.com/engine/install/).
+
+## Getting Started
+
+Get the `docker-compose.yml` and `.env.example` files from the AdventureLog repository. You can download them here:
+
+- [Docker Compose](https://github.com/seanmorley15/AdventureLog/blob/main/docker-compose.yml)
+- [Environment Variables](https://github.com/seanmorley15/AdventureLog/blob/main/.env.example)
+
+```bash
+wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/docker-compose.yml
+wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/.env.example
+cp .env.example .env
+```
+
+::: tip
+
+If running on an ARM based machine, you will need to use a different PostGIS Image. It is recommended to use the `tobi312/rpi-postgresql-postgis:15-3.3-alpine-arm` image or a custom version found [here](https://hub.docker.com/r/tobi312/rpi-postgresql-postgis/tags). The AdventureLog containers are ARM compatible.
+
+:::
+
+## Configuration
+
+The `.env` file contains all the configuration settings for your AdventureLog instance. Here’s a breakdown of each section:
+
+### 🌐 Frontend (web)
+
+| Name | Required | Description | Default Value |
+| ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
+| `PUBLIC_SERVER_URL` | Yes | Used by the frontend SSR server to connect to the backend. Almost every user user will **never have to change this from default**! | `http://server:8000` |
+| `ORIGIN` | Sometimes | Needed only if not using HTTPS. Set it to the domain or IP you'll use to access the frontend. | `http://localhost:8015` |
+| `BODY_SIZE_LIMIT` | Yes | Maximum upload size in bytes. | `Infinity` |
+| `FRONTEND_PORT` | Yes | Port that the frontend will run on inside Docker. | `8015` |
+
+### 🐘 PostgreSQL Database
+
+| Name | Required | Description | Default Value |
+| ------------------- | -------- | --------------------- | ------------- |
+| `PGHOST` | Yes | Internal DB hostname. | `db` |
+| `POSTGRES_DB` | Yes | DB name. | `database` |
+| `POSTGRES_USER` | Yes | DB user. | `adventure` |
+| `POSTGRES_PASSWORD` | Yes | DB password. | `changeme123` |
+
+### 🔒 Backend (server)
+
+| Name | Required | Description | Default Value |
+| ----------------------- | -------- | ---------------------------------------------------------------------------------- | --------------------------------------------- |
+| `SECRET_KEY` | Yes | Django secret key. Change this in production! | `changeme123` |
+| `DJANGO_ADMIN_USERNAME` | Yes | Default Django admin username. | `admin` |
+| `DJANGO_ADMIN_PASSWORD` | Yes | Default Django admin password. | `admin` |
+| `DJANGO_ADMIN_EMAIL` | Yes | Default admin email. | `admin@example.com` |
+| `PUBLIC_URL` | Yes | Publicly accessible URL of the **backend**. Used for generating image URLs. | `http://localhost:8016` |
+| `CSRF_TRUSTED_ORIGINS` | Yes | Comma-separated list of frontend/backend URLs that are allowed to submit requests. | `http://localhost:8016,http://localhost:8015` |
+| `FRONTEND_URL` | Yes | URL to the **frontend**, used for email generation. | `http://localhost:8015` |
+| `BACKEND_PORT` | Yes | Port that the backend will run on inside Docker. | `8016` |
+| `DEBUG` | No | Should be `False` in production. | `False` |
+
+## Optional Configuration
+
+- [Disable Registration](../configuration/disable_registration.md)
+- [Google Maps](../configuration/google_maps_integration.md)
+- [Email Configuration](../configuration/email.md)
+- [Immich Integration](../configuration/immich_integration.md)
+- [Umami Analytics](../configuration/analytics.md)
+
+## Running the Containers
+
+Once you've configured `.env`, you can start AdventureLog with:
+
+```bash
+docker compose up -d
+```
+
+Enjoy using AdventureLog! 🎉
diff --git a/documentation/docs/install/getting_started.md b/documentation/docs/install/getting_started.md
new file mode 100644
index 0000000..ff8d4b5
--- /dev/null
+++ b/documentation/docs/install/getting_started.md
@@ -0,0 +1,26 @@
+# 🚀 Install Options for AdventureLog
+
+AdventureLog can be installed in a variety of ways, depending on your platform or preference.
+
+## 📦 Docker Quick Start
+
+::: tip Quick Start Script
+**The fastest way to get started:**
+[Install AdventureLog with a single command →](quick_start.md)
+Perfect for Docker beginners.
+:::
+
+## 🐳 Popular Installation Methods
+
+- [Docker](docker.md) — Simple containerized setup
+- [Proxmox LXC](proxmox_lxc.md) — Lightweight virtual environment
+- [Synology NAS](synology_nas.md) — Self-host on your home NAS
+- [Kubernetes + Kustomize](kustomize.md) — Advanced, scalable deployment
+- [Unraid](unraid.md) — Easy integration for homelabbers
+- [Umbrel](https://apps.umbrel.com/app/adventurelog) — Home server app store
+
+## ⚙️ Advanced & Alternative Setups
+
+- [Nginx Proxy Manager](nginx_proxy_manager.md) — Easy reverse proxy config
+- [Traefik](traefik.md) — Dynamic reverse proxy with automation
+- [Caddy](caddy.md) — Automatic HTTPS with a clean config
diff --git a/documentation/docs/install/kustomize.md b/documentation/docs/install/kustomize.md
new file mode 100644
index 0000000..2c6e09b
--- /dev/null
+++ b/documentation/docs/install/kustomize.md
@@ -0,0 +1,34 @@
+# Kubernetes and Kustomize (k8s)
+
+_AdventureLog can be run inside a kubernetes cluster using [kustomize](https://kustomize.io/)._
+
+## Prerequisites
+
+A working kubernetes cluster. AdventureLog has been tested on k8s, but any Kustomize-capable flavor should be easy to use.
+
+## Cluster Routing
+
+Because the AdventureLog backend must be reachable by **both** the web browser and the AdventureLog frontend, k8s-internal routing mechanisms traditional for standing up other similar applications **cannot** be used.
+
+In order to host AdventureLog in your cluster, you must therefor configure an internally and externally resolvable ingress that routes to your AdventureLog backend container.
+
+Once you have made said ingress, set `PUBLIC_SERVER_URL` and `PUBLIC_URL` env variables below to the url of that ingress.
+
+## Tailscale and Headscale
+
+Many k8s homelabs choose to use [Tailscale](https://tailscale.com/) or similar projects to remove the need for open ports in your home firewall.
+
+The [Tailscale k8s Operator](https://tailscale.com/kb/1185/kubernetes/) will set up an externally resolvable service/ingress for your AdventureLog instance,
+but it will fail to resolve internally.
+
+You must [expose tailnet IPs to your cluster](https://tailscale.com/kb/1438/kubernetes-operator-cluster-egress#expose-a-tailnet-https-service-to-your-cluster-workloads) so the AdventureLog pods can resolve them.
+
+## Getting Started
+
+Take a look at the [example config](https://github.com/seanmorley15/AdventureLog/blob/main/kustomization.yml) and modify it for your use case.
+
+## Environment Variables
+
+Look at the [environment variable summary](docker.md#configuration) in the docker install section to see available and required configuration options.
+
+Enjoy AdventureLog! 🎉
diff --git a/documentation/docs/install/nginx_proxy_manager.md b/documentation/docs/install/nginx_proxy_manager.md
new file mode 100644
index 0000000..a6b661a
--- /dev/null
+++ b/documentation/docs/install/nginx_proxy_manager.md
@@ -0,0 +1,48 @@
+# Installation with Nginx Proxy Manager
+
+Nginx Proxy Manager is a simple and powerful tool that allows you to manage Nginx proxy hosts and SSL certificates. It is designed to be easy to use and configure, and it integrates well with Docker.
+
+It is fairly simple to set up Nginx Proxy Manager with AdventureLog.
+
+## Deploy AdventureLog using Docker
+
+View the [Docker installation guide](docker.md) for instructions on how to deploy AdventureLog using Docker.
+
+## Ensure Correct Environment Variables
+
+- `ORIGIN` - The domain where you will be hosting AdventureLog. This is where the **frontend** will be served from.
+- `PUBLIC_URL` - This needs to match the **outward port of the server** and be accessible from where the app is used. It is used for the creation of image URLs.
+
+## Setup Docker Network
+
+Ensure that the Nginx Proxy Manager and AdventureLog containers are on the same Docker network. You can create a new network using the following command:
+
+```bash
+docker network create nginx-proxy-manager
+```
+
+Add the following to the bottom of the `docker-compose.yml` file for the Nginx Proxy Manager service and the AdventureLog service.
+
+```yaml
+networks:
+ default:
+ name: nginx-proxy-manager
+ external: true
+```
+
+## Setting Up Nginx Proxy Manager
+
+1. Install Nginx Proxy Manager on your server. You can find the installation instructions [here](https://nginxproxymanager.com/setup/).
+2. Open the Nginx Proxy Manager web interface and log in with your credentials.
+3. Add a new proxy host for the AdventureLog **frontend**:
+ - **Domain Names**: Enter the domain name where you will be hosting AdventureLog.
+ - **Scheme**: `http`
+ - **Forward Hostname/IP**: `adventurelog-frontend` The name of the AdventureLog **frontend** container in the `docker-compose.yml` file.
+ - **Forward Port**: `3000` This is the internal port of the AdventureLog **frontend** container so you will not need to change it even if you change the external port.
+4. Add a new proxy host for the AdventureLog **backend**:
+ - **Domain Names**: Enter the domain name where you will be hosting AdventureLog.
+ - **Scheme**: `http`
+ - **Forward Hostname/IP**: `adventurelog-backend` The name of the AdventureLog **backend** container in the `docker-compose.yml` file.
+ - **Forward Port**: `80` This is the internal port of the AdventureLog **backend** container so you will not need to change it even if you change the external port.
+
+This will allow you to access AdventureLog using the domain name you specified in the Nginx Proxy Manager configuration.
diff --git a/documentation/docs/install/proxmox_lxc.md b/documentation/docs/install/proxmox_lxc.md
new file mode 100644
index 0000000..d216b60
--- /dev/null
+++ b/documentation/docs/install/proxmox_lxc.md
@@ -0,0 +1,4 @@
+# Proxmox LXC 🐧
+
+AdventureLog can be installed in a Proxmox LXC container. This script created by the community will help you install AdventureLog in a Proxmox LXC container.
+[Proxmox VE Helper-Scripts](https://community-scripts.github.io/ProxmoxVE/scripts?id=adventurelog)
diff --git a/documentation/docs/install/quick_start.md b/documentation/docs/install/quick_start.md
new file mode 100644
index 0000000..64dbdce
--- /dev/null
+++ b/documentation/docs/install/quick_start.md
@@ -0,0 +1,45 @@
+# 🚀 Quick Start Install
+
+Install **AdventureLog** in seconds using our automated script.
+
+## 🧪 One-Liner Install
+
+```bash
+curl -sSL https://get.adventurelog.app | bash
+```
+
+This will:
+
+- Check dependencies (Docker, Docker Compose)
+- Set up project directory
+- Download required files
+- Prompt for basic configuration (like domain name)
+- Start AdventureLog with Docker Compose
+
+## ✅ Requirements
+
+- Docker + Docker Compose
+- Linux server or VPS
+- Optional: Domain name for HTTPS
+
+## 🔍 What It Does
+
+The script automatically:
+
+1. Verifies Docker is installed and running
+2. Downloads `docker-compose.yml` and `.env`
+3. Prompts you for domain and port settings
+4. Waits for services to start
+5. Prints success info with next steps
+
+## 🧼 Uninstall
+
+To remove everything:
+
+```bash
+cd adventurelog
+docker compose down -v
+rm -rf adventurelog
+```
+
+Need more control? Explore other [install options](getting_started.md) like Docker, Proxmox, Synology NAS, and more.
diff --git a/documentation/docs/install/synology_nas.md b/documentation/docs/install/synology_nas.md
new file mode 100644
index 0000000..bb38eb6
--- /dev/null
+++ b/documentation/docs/install/synology_nas.md
@@ -0,0 +1,5 @@
+# Installation on a Synology NAS
+
+AdventureLog can be deployed on a Synology NAS using Docker. This guide from Marius Hosting will walk you through the process.
+
+[Read the guide Here](https://mariushosting.com/how-to-install-adventurelog-on-your-synology-nas/)
diff --git a/documentation/docs/install/traefik.md b/documentation/docs/install/traefik.md
new file mode 100644
index 0000000..2923136
--- /dev/null
+++ b/documentation/docs/install/traefik.md
@@ -0,0 +1,7 @@
+# Installation with Traefik
+
+Traefik is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy. It is designed to be simple to use and configure, and it integrates well with Docker.
+
+AdventureLog has a built-in Traefik configuration that makes it easy to deploy and manage your AdventureLog instance.
+
+The most recent version of the Traefik `docker-compose.yml` file can be found in the [AdventureLog GitHub repository](https://github.com/seanmorley15/AdventureLog/blob/main/docker-compose-traefik.yaml).
diff --git a/documentation/docs/install/unraid.md b/documentation/docs/install/unraid.md
new file mode 100644
index 0000000..c8726f6
--- /dev/null
+++ b/documentation/docs/install/unraid.md
@@ -0,0 +1,71 @@
+# Installation with Unraid
+
+AdventureLog is available in the Unraid Community Applications store. You can install it by searching for `AdventureLog` in the Community Applications store, where you will find the frontend and the backend. The database can be found by searching `PostGIS`.
+
+Community Applications Page for AdventureLog: [AdventureLog on CA Store](https://unraid.net/community/apps?q=AdventureLog)\
+Community Applications Page for PostGIS: [PostGIS on CA Store](https://unraid.net/community/apps?q=PostGIS)
+
+## Installation Configuration
+
+- **Note:** It is recommended to install the applications in the order of these instructions, as failing to do so could cause issues.\
+- Container names can be set to whatever you desire.
+- Also ensure they are all on the same custom network so they can communicate with one another. You can create one by running the following command in your command line, with `example` being set to your desired name. This network will then show up for selection when making the apps/containers.
+
+```bash
+docker network create example
+```
+
+## Database
+
+- Network type should be set to your **custom network**.
+- There is **no** AdventureLog---Database app, to find the database application search for `PostGIS` on the Unraid App Store then add and fill out the fields as shown below
+- Change the repository version to `postgis/postgis:15-3.3`
+- Ensure that the variables ```POSTGRES_DB```, ```POSTGRES_USER```, and ```POSTGRES_PASSWORD``` are set in the ```PostGIS``` container. If not, then add them as custom variables. The template should have ```POSTGRES_PASSWORD``` already and you will simply have to add ```POSTGRES_DB``` and ```POSTGRES_USER```.
+- The forwarded port of ```5012``` is not needed unless you plan to access the database outside of the container's network.
+
+| Name | Required | Description | Default Value |
+| ------------------- | -------- | -------------------------------------------------------------------------------- | --------------- |
+| `POSTGRES_DB` | Yes | The name of the database in PostGIS. | `N/A` |
+| `POSTGRES_USER` | Yes | Name of the user generated on first start that will have access to the database. | `N/A` |
+| `POSTGRES_PASSWORD` | Yes | Password of the user that will be generated on first start. | `N/A` |
+
+- Here's some visual instructions of how to configure the database template, click the image to open larger version in new tab.\
+[](/unraid-config-2.png)
+
+## Backend
+
+- Network type should be set to your **custom network**.
+- **Note:** If you're running the server in a docker network that is other than "host" (for example "bridge"), then you need to add the IP of the host machine in the CSRF Trusted Origins variable instead of using localhost. This is only necessary when accessing locally, otherwise you will use the domain name.
+
+| Name | Required | Description | Default Value |
+| ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
+| `API Port` | Yes | This is the port of the backend. This is a port, not a variable. | `8016` |
+| `PGHOST` | Yes | This is how the backend will access the database. Use the database container's name. | `N/A` |
+| `PGDATABASE` | Yes | Name of the database in PostGIS to access. | `N/A` |
+| `PGUSER` | Yes | Name of the user to access with. This is the same as the variable in the database. | `N/A` |
+| `PGPASSWORD` | Yes | Password of the user it's accessing with. This is the same as the variable in the database. | `N/A` |
+| `SECRET_KEY` | Yes | Secret Backend Key. Change to anything. | `N/A` |
+| `DJANGO_ADMIN_USERNAME` | Yes | Default username for admin access. | `admin` |
+| `DJANGO_ADMIN_EMAIL` | Yes | Default admin user's email. **Note:** You cannot make more than one user with each email. | `N/A` |
+| `DJANGO_ADMIN_PASSWORD` | Yes | Default password for admin access. Change after initial login. | `N/A` |
+| `PUBLIC_URL` | Yes | This needs to match how you will connect to the backend, so either local ip with matching port or domain. It is used for the creation of image URLs. | `http://IP_ADDRESS:8016` |
+| `FRONTEND_URL` | Yes | This needs to match how you will connect to the frontend, so either local ip with matching port or domain. This link should be available for all users. Used for email generation. | `http://IP_ADDRESS:8015` |
+| `CSRF_TRUSTED_ORIGINS` | Yes | This needs to be changed to the URLs of how you connect to your backend server and frontend. These values are comma-separated and usually the same as the 2 above values. | `http://IP_ADDRESS:8016,http://IP_ADDRESS:8015` |
+
+- Here's some visual instructions of how to configure the backend template, click the image to open larger version in new tab.\
+[](/unraid-config-1.png)
+
+## Frontend
+
+- Network type should be set to your **custom network**.
+- **Note:** The default value for ```PUBLIC_SERVER_URL``` is ```http://IP_ADDRESS:8000```, however ```IP_ADDRESS``` **should be changed** to the name of the backend container for simplicity.
+
+| Name | Required | Description | Default Value |
+| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ |
+| `WEB UI Port` | Yes | The port of the frontend. This is not a variable. | `8015` |
+| `PUBLIC_SERVER_URL` | Yes | What the frontend SSR server uses to connect to the backend. Change `IP_ADDRESS` to the name of the backend container. | `http://IP_ADDRESS:8000` |
+| `ORIGIN` | Sometimes| Set to the URL you will access the frontend from, such as localhost with correct port, or set it to the domain of what you will access the app from. | `http://IP_ADDRESS:8015` |
+| `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 **bytes**. | `Infinity` |
+
+- Here's some visual instructions of how to configure the frontend template, click the image to open larger version in new tab.\
+[](/unraid-config-3.png)
diff --git a/documentation/docs/intro.md b/documentation/docs/intro.md
deleted file mode 100644
index a343601..0000000
--- a/documentation/docs/intro.md
+++ /dev/null
@@ -1,9 +0,0 @@
----
-sidebar_position: 1
----
-
-# Intro 1️⃣
-
-This tutorial will guide you how to get AdventureLog up and running on your local machine quickly and easily.
-
-Click next below to get started:
diff --git a/documentation/docs/intro/adventurelog_overview.md b/documentation/docs/intro/adventurelog_overview.md
new file mode 100644
index 0000000..80cf63d
--- /dev/null
+++ b/documentation/docs/intro/adventurelog_overview.md
@@ -0,0 +1,32 @@
+# About AdventureLog
+
+Starting from a simple idea of tracking travel locations (called adventures), AdventureLog has grown into a full-fledged travel companion. With AdventureLog, you can log your adventures, keep track of where you've been on the world map, plan your next trip collaboratively, and share your experiences with friends and family. **AdventureLog is the ultimate travel companion for the modern-day explorer**.
+
+## Features
+
+- **Track Your Adventures** 🌍: Log your adventures and keep track of where you've been on the world map.
+ - Adventures can store a variety of information, including the location, date, and description.
+ - Adventures can be sorted into custom categories for easy organization.
+ - Adventures can be marked as private or public, allowing you to share your adventures with friends and family.
+ - Keep track of the countries and regions you've visited with the world travel book.
+- **Plan Your Next Trip** 📃: Take the guesswork out of planning your next adventure with an easy-to-use itinerary planner.
+ - Itineraries can be created for any number of days and can include multiple destinations.
+ - Itineraries include many planning features like flight information, notes, checklists, and links to external resources.
+ - Itineraries can be shared with friends and family for collaborative planning.
+- **Share Your Experiences** 📸: Share your adventures with friends and family and collaborate on trips together.
+ - Adventures and itineraries can be shared via a public link or directly with other AdventureLog users.
+ - Collaborators can view and edit shared itineraries (collections), making planning a breeze.
+
+## Why AdventureLog?
+
+AdventureLog was created to solve a problem: the lack of a modern, open-source, user-friendly travel companion. Many existing travel apps are either too complex, too expensive, or too closed-off to be useful for the average traveler. AdventureLog aims to be the opposite: simple, beautiful, and open to everyone.
+
+### Open Source (GPL-3.0)
+
+AdventureLog is open-source software, licensed under the GPL-3.0 license. This means that you are free to use, modify, and distribute AdventureLog as you see fit. The source code is available on GitHub, and contributions are welcome from anyone who wants to help improve the project.
+
+## About the Maintainer
+
+Hi, I'm [Sean Morley](https://seanmorley.com), the creator of AdventureLog. I'm an Electrical Engineering student at the University of Connecticut, and I'm passionate about open-source software and building modern tools that help people solve real-world problems. I created AdventureLog to solve a problem: the lack of a modern, open-source, user-friendly travel companion. Many existing travel apps are either too complex, too expensive, or too closed-off to be useful for the average traveler. AdventureLog aims to be the opposite: simple, beautiful, and open to everyone.
+
+I hope you enjoy using AdventureLog as much as I enjoy creating it! If you have any questions, feedback, or suggestions, feel free to reach out to me via the email address listed on my website. I'm always happy to hear from users and help in any way I can. Thank you for using AdventureLog, and happy travels! 🌍
diff --git a/documentation/docs/troubleshooting/login_unresponsive.md b/documentation/docs/troubleshooting/login_unresponsive.md
new file mode 100644
index 0000000..9abf6a0
--- /dev/null
+++ b/documentation/docs/troubleshooting/login_unresponsive.md
@@ -0,0 +1,18 @@
+# Troubleshooting: Login and Registration Unresponsive
+
+When you encounter issues with the login and registration pages being unresponsive in AdventureLog, it can be due to various reasons. This guide will help you troubleshoot and resolve the unresponsive login and registration pages in AdventureLog.
+
+1. Check to make sure the backend container is running and accessible.
+
+ - Check the backend container logs to see if there are any errors or issues blocking the container from running.
+2. Check the connection between the frontend and backend containers.
+
+ - Attempt login with the browser console network tab open to see if there are any errors or issues with the connection between the frontend and backend containers. If there is a connection issue, the code will show an error like `Failed to load resource: net::ERR_CONNECTION_REFUSED`. If this is the case, check the `PUBLIC_SERVER_URL` in the frontend container and refer to the installation docs to ensure the correct URL is set.
+ - If the error is `403`, continue to the next step.
+
+3. The error most likely is due to a CSRF security config issue in either the backend or frontend.
+
+ - Check that the `ORIGIN` variable in the frontend is set to the URL where the frontend is access and you are accessing the app from currently.
+ - Check that the `CSRF_TRUSTED_ORIGINS` variable in the backend is set to a comma separated list of the origins where you use your backend server and frontend. One of these values should match the `ORIGIN` variable in the frontend.
+
+4. If you are still experiencing issues, please refer to the [AdventureLog Discord Server](https://discord.gg/wRbQ9Egr8C) for further assistance, providing as much detail as possible about the issue you are experiencing!
diff --git a/documentation/docs/troubleshooting/nginx_failed.md b/documentation/docs/troubleshooting/nginx_failed.md
new file mode 100644
index 0000000..72e6a94
--- /dev/null
+++ b/documentation/docs/troubleshooting/nginx_failed.md
@@ -0,0 +1,45 @@
+# Troubleshooting: `Starting nginx: nginx failed!` in the Backend Container
+
+::: tip
+As of 1-10-2024, this should be resolved in the latest version of AdventureLog. If you are still experiencing this issue, please reach out to the AdventureLog community on Discord or GitHub for further assistance.
+:::
+
+The AdventureLog backend container uses a built-in Nginx container with a built-in nginx config that relies on the name `server` to be the service name of the backend container. If the Nginx service fails to start in the backend container, the whole backend service will keep restarting and fail to start.
+
+**The primary reason for this error is changing the backend service name `server` to something different**
+
+If you're experiencing issues with the Nginx service failing to start in the backend container, follow these troubleshooting steps to resolve the issue.
+
+### 1. **Check the `server` Service Name**:
+
+- Verify that the service name of the backend container is set to `server` in the `docker-compose.yml` file.
+- The service name should be set to `server` in the `docker-compose.yml` file. For example:
+ ```yaml
+ server:
+ image: ghcr.io/seanmorley15/adventurelog-backend:latest
+ container_name: adventurelog-backend
+ ```
+
+### 2. **To keep the backend service name different**:
+
+- If you want to keep the backend service name different from `server`, you can mount a custom Nginx configuration file to the backend container.
+
+ - Get the default Nginx configuration file from the AdventureLog repository:
+
+ ```bash
+ wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/refs/heads/main/backend/nginx.conf
+ ```
+
+ - Update the `nginx.conf` file to replace all occurrences of `server` with your custom service name.
+ - Mount the custom Nginx configuration file to the backend container in the `docker-compose.yml` file. For example:
+ ```yaml
+ server:
+ image: ghcr.io/seanmorley15/adventurelog-backend:latest
+ container_name: adventurelog-backend
+ volumes:
+ - ./nginx.conf:/etc/nginx/nginx.conf
+ ```
+
+### 3. **Restart the Backend Container**:
+
+These steps should help you resolve the issue with the Nginx service failing to start in the backend container. If you continue to face issues, please reach out to the AdventureLog community on Discord or GitHub for further assistance.
diff --git a/documentation/docs/troubleshooting/no_images.md b/documentation/docs/troubleshooting/no_images.md
new file mode 100644
index 0000000..041b56e
--- /dev/null
+++ b/documentation/docs/troubleshooting/no_images.md
@@ -0,0 +1,20 @@
+# Troubleshooting: Images Not Displayed in AdventureLog
+
+The AdventureLog backend container uses a built-in Nginx container to serve media to the frontend. The `PUBLIC_URL` environment variable is set to the external URL of the **backend** container. This URL is used to generate the URLs for the images in the frontend. If this URL is not set correctly or not accessible from the frontend, the images will not be displayed.
+
+If you're experiencing issues with images not displaying in AdventureLog, follow these troubleshooting steps to resolve the issue.
+
+1. **Check the `PUBLIC_URL` Environment Variable**:
+
+ - Verify that the `PUBLIC_URL` environment variable is set correctly in the `docker-compose.yml` file for the `server` service.
+ - The `PUBLIC_URL` should be set to the external URL of the backend container. For example:
+ ```
+ PUBLIC_URL=http://backend.example.com
+ ```
+
+2. **Check `CSRF_TRUSTED_ORIGINS` Environment Variable**:
+ - If you have set the `CSRF_TRUSTED_ORIGINS` environment variable in the `docker-compose.yml` file, ensure that it includes the frontend URL and the backend URL.
+ - For example:
+ ```
+ CSRF_TRUSTED_ORIGINS=http://frontend.example.com,http://backend.example.com
+ ```
diff --git a/documentation/docs/usage/usage.md b/documentation/docs/usage/usage.md
new file mode 100644
index 0000000..aa27cf3
--- /dev/null
+++ b/documentation/docs/usage/usage.md
@@ -0,0 +1,33 @@
+# How to use AdventureLog
+
+Welcome to AdventureLog! This guide will help you get started with AdventureLog and provide you with an overview of the features available to you.
+
+## Key Terms
+
+#### Adventures
+
+- **Adventure**: think of an adventure as a point on a map, a location you want to visit, or a place you want to explore. An adventure can be anything you want it to be, from a local park to a famous landmark.
+- **Visit**: a visit is added to an adventure. It contains a date and notes about when the adventure was visited. If an adventure is visited multiple times, multiple visits can be added. If there are no visits on an adventure or the date of all visits is in the future, the adventure is considered planned. If the date of the visit is in the past, the adventure is considered completed.
+- **Category**: a category is a way to group adventures together. For example, you could have a category for parks, a category for museums, and a category for restaurants.
+- **Tag**: a tag is a way to add additional information to an adventure. For example, you could have a tag for the type of cuisine at a restaurant or the type of art at a museum. Multiple tags can be added to an adventure.
+- **Image**: an image is a photo that is added to an adventure. Images can be added to an adventure to provide a visual representation of the location or to capture a memory of the visit. These can be uploaded from your device or with a service like [Immich](/docs/configuration/immich_integration) if the integration is enabled.
+- **Attachment**: an attachment is a file that is added to an adventure. Attachments can be added to an adventure to provide additional information, such as a map of the location or a brochure from the visit.
+
+#### Collections
+
+- **Collection**: a collection is a way to group adventures together. Collections are flexible and can be used in many ways. When no start or end date is added to a collection, it acts like a folder to group adventures together. When a start and end date is added to a collection, it acts like a trip to group adventures together that were visited during that time period. With start and end dates, the collection is transformed into a full itinerary with a map showing the route taken between adventures.
+- **Transportation**: a transportation is a collection exclusive feature that allows you to add transportation information to your trip. This can be used to show the route taken between locations and the mode of transportation used. It can also be used to track flight information, such as flight number and departure time.
+- **Lodging**: a lodging is a collection exclusive feature that allows you to add lodging information to your trip. This can be used to plan where you will stay during your trip and add notes about the lodging location. It can also be used to track reservation information, such as reservation number and check-in time.
+- **Note**: a note is a collection exclusive feature that allows you to add notes to your trip. This can be used to add additional information about your trip, such as a summary of the trip or a list of things to do. Notes can be assigned to a specific day of the trip to help organize the information.
+- **Checklist**: a checklist is a collection exclusive feature that allows you to add a checklist to your trip. This can be used to create a list of things to do during your trip or for planning purposes like packing lists. Checklists can be assigned to a specific day of the trip to help organize the information.
+
+#### World Travel
+
+- **World Travel**: the world travel feature of AdventureLog allows you to track the countries, regions, and cities you have visited during your lifetime. You can add visits to countries, regions, and cities, and view statistics about your travels. The world travel feature is a fun way to visualize where you have been and where you want to go next.
+ - **Country**: a country is a geographical area that is recognized as an independent nation. You can add visits to countries to track where you have been.
+ - **Region**: a region is a geographical area that is part of a country. You can add visits to regions to track where you have been within a country.
+ - **City**: a city is a geographical area that is a populated urban center. You can add visits to cities to track where you have been within a region.
+
+## Tutorial Video
+
+VIDEO
diff --git a/documentation/docusaurus.config.ts b/documentation/docusaurus.config.ts
deleted file mode 100644
index da27580..0000000
--- a/documentation/docusaurus.config.ts
+++ /dev/null
@@ -1,146 +0,0 @@
-import { themes as prismThemes } from "prism-react-renderer";
-import type { Config } from "@docusaurus/types";
-import type * as Preset from "@docusaurus/preset-classic";
-
-const config: Config = {
- title: "AdventureLog",
- tagline: "Embark, Explore, Remember. 🗺️",
- favicon: "img/favicon.png",
-
- // Set the production url of your site here
- url: "https://docs.adventurelog.app/",
- // Set the // pathname under which your site is served
- // For GitHub pages deployment, it is often '//'
- baseUrl: "/",
-
- // GitHub pages deployment config.
- // If you aren't using GitHub pages, you don't need these.
- organizationName: "seanmorley", // Usually your GitHub org/user name.
- projectName: "adventurelog", // Usually your repo name.
-
- onBrokenLinks: "throw",
- onBrokenMarkdownLinks: "warn",
-
- plugins: [require.resolve("docusaurus-lunr-search")],
-
- // Even if you don't use internationalization, you can use this field to set
- // useful metadata like html lang. For example, if your site is Chinese, you
- // may want to replace "en" with "zh-Hans".
- i18n: {
- defaultLocale: "en",
- locales: ["en"],
- },
-
- presets: [
- [
- "classic",
- {
- docs: {
- sidebarPath: "./sidebars.ts",
- // Please change this to your repo.
- // Remove this to remove the "edit this page" links.
- editUrl:
- "https://github.com/seanmorley15/AdventureLog/tree/main/documentation",
- },
- // blog: {
- // showReadingTime: true,
- // // Please change this to your repo.
- // // Remove this to remove the "edit this page" links.
- // editUrl:
- // "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
- // },
- theme: {
- customCss: "./src/css/custom.css",
- },
- } satisfies Preset.Options,
- ],
- ],
-
- themeConfig: {
- colorMode: {
- defaultMode: "dark",
- disableSwitch: false,
- respectPrefersColorScheme: false,
- },
- // Replace with your project's social card
- image: "img/docusaurus-social-card.jpg",
- navbar: {
- title: "AdventureLog Docs",
- logo: {
- alt: "AdventureLog Logo",
- src: "img/favicon.png",
- },
- items: [
- {
- type: "docSidebar",
- sidebarId: "tutorialSidebar",
- position: "left",
- label: "Documentation",
- },
- {
- to: "https://www.buymeacoffee.com/seanmorley15",
- label: "Sponsor 💖",
- position: "right",
- },
- // { to: "/blog", label: "Blog", position: "left" },
- {
- to: "https://github.com/seanmorley15/adventurelog",
- label: "GitHub",
- position: "right",
- },
- {
- to: "https://discord.gg/wRbQ9Egr8C",
- label: "Discord",
- position: "right",
- },
- ],
- },
- footer: {
- style: "dark",
- links: [
- {
- title: "Docs",
- items: [
- {
- label: "Intro",
- to: "/docs/intro",
- },
- {
- label: "Installation",
- to: "/docs/Installation/docker",
- },
- ],
- },
- {
- title: "Community",
- items: [
- {
- label: "GitHub",
- href: "https://github.com/seanmorley15/adventurelog",
- },
- {
- label: "Discord",
- href: "https://discord.gg/wRbQ9Egr8C",
- },
- ],
- },
- // {
- // title: "More",
- // items: [
- // {
- // label: "Blog",
- // to: "/blog",
- // },
- // ],
- // },
- ],
- copyright: `Copyright © ${new Date().getFullYear()} Sean Morley Built with Docusaurus.`,
- },
- prism: {
- theme: prismThemes.github,
- darkTheme: prismThemes.dracula,
- },
- } satisfies Preset.ThemeConfig,
-};
-
-export default config;
diff --git a/documentation/index.md b/documentation/index.md
new file mode 100644
index 0000000..8d5b4cf
--- /dev/null
+++ b/documentation/index.md
@@ -0,0 +1,295 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+ name: "AdventureLog"
+ text: "The ultimate travel companion."
+ tagline: Discover new places, track your adventures, and share your experiences with friends and family.
+ actions:
+ - theme: brand
+ text: Get Started
+ link: /docs/install/getting_started
+ - theme: alt
+ text: About
+ link: /docs/intro/adventurelog_overview
+ - theme: alt
+ text: Demo
+ link: https://demo.adventurelog.app
+ image:
+ src: ./adventurelog.svg
+ alt: AdventureLog Map Logo
+
+features:
+ - title: "Track Your Adventures"
+ details: "Log your adventures and keep track of where you've been on the world map."
+ icon: 📍
+ - title: "Plan Your Next Trip"
+ details: "Take the guesswork out of planning your next adventure with an easy-to-use itinerary planner."
+ icon: 📅
+ - title: "Share Your Experiences"
+ details: "Share your adventures with friends and family and collaborate on trips together."
+ icon: 📸
+---
+
+## ⚡️ Quick Start
+
+Get AdventureLog running in under 60 seconds:
+
+```bash [One-Line Install]
+curl -sSL https://get.adventurelog.app | bash
+```
+
+You can also explore our [full installation guide](/docs/install/getting_started) for plenty of options, including Docker, Proxmox, Synology NAS, and more.
+
+## 📸 See It In Action
+
+::: details 🗂️ **Adventure Overview & Management**
+Manage your full list of adventures with ease. View upcoming and past trips, filter and sort by status, date, or category to find exactly what you want quickly.
+
+
+
+
+### **Frontend Excellence**
+
+- 🎨 **SvelteKit** - Lightning-fast, modern web framework
+- 💨 **TailwindCSS** - Utility-first styling for beautiful designs
+- 🎭 **DaisyUI** - Beautiful, accessible component library
+- 🗺️ **MapLibre** - Interactive, customizable mapping
+
+
+
+
+
+### **Backend Power**
+
+- 🐍 **Django** - Robust, scalable web framework
+- 🗺️ **PostGIS** - Advanced geospatial database capabilities
+- 🔌 **Django REST** - Modern API architecture
+- 🔐 **AllAuth** - Comprehensive authentication system
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/documentation/public/authentik_settings.png b/documentation/public/authentik_settings.png
new file mode 100644
index 0000000..d48e2c3
Binary files /dev/null and b/documentation/public/authentik_settings.png differ
diff --git a/documentation/public/github_settings.png b/documentation/public/github_settings.png
new file mode 100644
index 0000000..5d54369
Binary files /dev/null and b/documentation/public/github_settings.png differ
diff --git a/documentation/public/unraid-config-1.png b/documentation/public/unraid-config-1.png
new file mode 100644
index 0000000..36df25c
Binary files /dev/null and b/documentation/public/unraid-config-1.png differ
diff --git a/documentation/public/unraid-config-2.png b/documentation/public/unraid-config-2.png
new file mode 100644
index 0000000..073b5a8
Binary files /dev/null and b/documentation/public/unraid-config-2.png differ
diff --git a/documentation/public/unraid-config-3.png b/documentation/public/unraid-config-3.png
new file mode 100644
index 0000000..6a0e49b
Binary files /dev/null and b/documentation/public/unraid-config-3.png differ
diff --git a/documentation/sidebars.ts b/documentation/sidebars.ts
deleted file mode 100644
index 7dfdcb5..0000000
--- a/documentation/sidebars.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
-
-/**
- * Creating a sidebar enables you to:
- - create an ordered group of docs
- - render a sidebar for each doc of that group
- - provide next/previous navigation
-
- The sidebars can be generated from the filesystem, or explicitly defined here.
-
- Create as many sidebars as you want.
- */
-const sidebars: SidebarsConfig = {
- // By default, Docusaurus generates a sidebar from the docs folder structure
- tutorialSidebar: [{ type: "autogenerated", dirName: "." }],
-
- // But you can create a sidebar manually
- /*
- tutorialSidebar: [
- 'intro',
- 'hello',
- {
- type: 'category',
- label: 'Tutorial',
- items: ['tutorial-basics/create-a-document'],
- },
- ],
- */
-};
-
-export default sidebars;
diff --git a/documentation/src/components/HomepageFeatures/index.tsx b/documentation/src/components/HomepageFeatures/index.tsx
deleted file mode 100644
index 04508d7..0000000
--- a/documentation/src/components/HomepageFeatures/index.tsx
+++ /dev/null
@@ -1,66 +0,0 @@
-import clsx from "clsx";
-import Heading from "@theme/Heading";
-import styles from "./styles.module.css";
-
-type FeatureItem = {
- title: string;
- Svg: React.ComponentType>;
- description: JSX.Element;
-};
-
-const FeatureList: FeatureItem[] = [
- {
- title: "Log Your Travels",
- Svg: require("@site/static/img/undraw_explore.svg").default,
- description: (
- <>
- AdventureLog is a simple way to log your travels and share them with the
- world. You can add photos, notes, and more to your logs.
-
- ),
- },
- {
- title: "Track Your World Travel",
- Svg: require("@site/static/img/undraw_adventure.svg").default,
- description: (
- <>
- Keep track of the countries you've visited, the regions you've explored,
- and the places you've been. You can also see your travel stats and
- milestones (coming soon).
-
- ),
- },
- {
- title: "View a Map of Your Travels",
- Svg: require("@site/static/img/undraw_map_dark.svg").default,
- description: <>See a map of all the places you've been.,
- },
-];
-
-function Feature({ title, Svg, description }: FeatureItem) {
- return (
-
-
-
-
-
{title}
-
{description}
-
-
-
-
- {FeatureList.map((props, idx) => (
-
-
- );
-}
diff --git a/documentation/src/components/HomepageFeatures/styles.module.css b/documentation/src/components/HomepageFeatures/styles.module.css
deleted file mode 100644
index b248eb2..0000000
--- a/documentation/src/components/HomepageFeatures/styles.module.css
+++ /dev/null
@@ -1,11 +0,0 @@
-.features {
- display: flex;
- align-items: center;
- padding: 2rem 0;
- width: 100%;
-}
-
-.featureSvg {
- height: 200px;
- width: 200px;
-}
diff --git a/documentation/src/css/custom.css b/documentation/src/css/custom.css
deleted file mode 100644
index 392267d..0000000
--- a/documentation/src/css/custom.css
+++ /dev/null
@@ -1,30 +0,0 @@
-/**
- * Any CSS included here will be global. The classic template
- * bundles Infima by default. Infima is a CSS framework designed to
- * work well for content-centric websites.
- */
-
-/* You can override the default Infima variables here. */
-:root {
- --ifm-color-primary: #2e8555;
- --ifm-color-primary-dark: #29784c;
- --ifm-color-primary-darker: #277148;
- --ifm-color-primary-darkest: #205d3b;
- --ifm-color-primary-light: #33925d;
- --ifm-color-primary-lighter: #359962;
- --ifm-color-primary-lightest: #3cad6e;
- --ifm-code-font-size: 95%;
- --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
-}
-
-/* For readability concerns, you should choose a lighter palette in dark mode. */
-[data-theme="dark"] {
- --ifm-color-primary: #256cc2;
- --ifm-color-primary-dark: #21af90;
- --ifm-color-primary-darker: #1fa588;
- --ifm-color-primary-darkest: #1a8870;
- --ifm-color-primary-light: #29d5b0;
- --ifm-color-primary-lighter: #32d8b4;
- --ifm-color-primary-lightest: #4fddbf;
- --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
-}
diff --git a/documentation/src/pages/index.module.css b/documentation/src/pages/index.module.css
deleted file mode 100644
index 9f71a5d..0000000
--- a/documentation/src/pages/index.module.css
+++ /dev/null
@@ -1,23 +0,0 @@
-/**
- * CSS files with the .module.css suffix will be treated as CSS modules
- * and scoped locally.
- */
-
-.heroBanner {
- padding: 4rem 0;
- text-align: center;
- position: relative;
- overflow: hidden;
-}
-
-@media screen and (max-width: 996px) {
- .heroBanner {
- padding: 2rem;
- }
-}
-
-.buttons {
- display: flex;
- align-items: center;
- justify-content: center;
-}
diff --git a/documentation/src/pages/index.tsx b/documentation/src/pages/index.tsx
deleted file mode 100644
index 2ad1cb4..0000000
--- a/documentation/src/pages/index.tsx
+++ /dev/null
@@ -1,45 +0,0 @@
-import clsx from "clsx";
-import Link from "@docusaurus/Link";
-import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
-import Layout from "@theme/Layout";
-import HomepageFeatures from "@site/src/components/HomepageFeatures";
-import Heading from "@theme/Heading";
-
-import styles from "./index.module.css";
-
-function HomepageHeader() {
- const { siteConfig } = useDocusaurusContext();
- return (
-
- );
-}
-
-export default function Home(): JSX.Element {
- const { siteConfig } = useDocusaurusContext();
- return (
-
-
-
-
- );
-}
diff --git a/documentation/src/pages/markdown-page.md b/documentation/src/pages/markdown-page.md
deleted file mode 100644
index 9756c5b..0000000
--- a/documentation/src/pages/markdown-page.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: Markdown page example
----
-
-# Markdown page example
-
-You don't need React to write simple standalone pages.
diff --git a/documentation/static/img/docusaurus-social-card.jpg b/documentation/static/img/docusaurus-social-card.jpg
deleted file mode 100644
index ffcb448..0000000
Binary files a/documentation/static/img/docusaurus-social-card.jpg and /dev/null differ
diff --git a/documentation/static/img/docusaurus.png b/documentation/static/img/docusaurus.png
deleted file mode 100644
index f458149..0000000
Binary files a/documentation/static/img/docusaurus.png and /dev/null differ
diff --git a/documentation/static/img/favicon.ico b/documentation/static/img/favicon.ico
deleted file mode 100644
index c01d54b..0000000
Binary files a/documentation/static/img/favicon.ico and /dev/null differ
diff --git a/documentation/static/img/logo.svg b/documentation/static/img/logo.svg
deleted file mode 100644
index 9db6d0d..0000000
--- a/documentation/static/img/logo.svg
+++ /dev/null
@@ -1 +0,0 @@
-
- Easy to Use
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/documentation/static/img/undraw_docusaurus_react.svg b/documentation/static/img/undraw_docusaurus_react.svg
deleted file mode 100644
index 94b5cf0..0000000
--- a/documentation/static/img/undraw_docusaurus_react.svg
+++ /dev/null
@@ -1,170 +0,0 @@
-
- Powered by React
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/documentation/static/img/undraw_docusaurus_tree.svg b/documentation/static/img/undraw_docusaurus_tree.svg
deleted file mode 100644
index d9161d3..0000000
--- a/documentation/static/img/undraw_docusaurus_tree.svg
+++ /dev/null
@@ -1,40 +0,0 @@
-
- Focus on What Matters
-
diff --git a/documentation/static/img/undraw_explore.svg b/documentation/static/img/undraw_explore.svg
deleted file mode 100644
index 5fbdb8f..0000000
--- a/documentation/static/img/undraw_explore.svg
+++ /dev/null
@@ -1 +0,0 @@
-
-
+
-
-
- {$t('about.about')} AdventureLog) {
+ let collectionId = event.detail;
+ // Create a copy to avoid modifying the original directly
+ const updatedCollections = adventure.collections ? [...adventure.collections] : [];
+
+ // Add the new collection if not already present
+ if (!updatedCollections.some((c) => String(c) === String(collectionId))) {
+ updatedCollections.push(collectionId);
+ }
+
let res = await fetch(`/api/adventures/${adventure.id}`, {
method: 'PATCH',
headers: {
'Content-Type': 'application/json'
},
- body: JSON.stringify({ collection: null })
+ body: JSON.stringify({ collections: updatedCollections })
});
+
if (res.ok) {
- addToast('info', `${$t('adventures.collection_remove_success')}`);
- dispatch('delete', adventure.id);
+ // Only update the adventure.collections after server confirms success
+ adventure.collections = updatedCollections;
+ addToast('info', `${$t('adventures.collection_link_success')}`);
} else {
- addToast('error', `${$t('adventures.collection_remove_error')}`);
+ addToast('error', `${$t('adventures.collection_link_error')}`);
}
}
- async function linkCollection(event: CustomEvent) {
+ async function removeFromCollection(event: CustomEvent) {
let collectionId = event.detail;
- let res = await fetch(`/api/adventures/${adventure.id}`, {
- method: 'PATCH',
- headers: {
- 'Content-Type': 'application/json'
- },
- body: JSON.stringify({ collection: collectionId })
- });
- if (res.ok) {
- console.log('Adventure linked to collection');
- addToast('info', `${$t('adventures.collection_link_success')}`);
- isCollectionModalOpen = false;
- dispatch('delete', adventure.id);
- } else {
- addToast('error', `${$t('adventures.collection_link_error')}`);
+ if (!collectionId) {
+ addToast('error', `${$t('adventures.collection_remove_error')}`);
+ return;
+ }
+
+ // Create a copy to avoid modifying the original directly
+ if (adventure.collections) {
+ const updatedCollections = adventure.collections.filter(
+ (c) => String(c) !== String(collectionId)
+ );
+
+ let res = await fetch(`/api/adventures/${adventure.id}`, {
+ method: 'PATCH',
+ headers: {
+ 'Content-Type': 'application/json'
+ },
+ body: JSON.stringify({ collections: updatedCollections })
+ });
+
+ if (res.ok) {
+ // Only update adventure.collections after server confirms success
+ adventure.collections = updatedCollections;
+ addToast('info', `${$t('adventures.collection_remove_success')}`);
+ } else {
+ addToast('error', `${$t('adventures.collection_remove_error')}`);
+ }
}
}
@@ -100,7 +156,12 @@
{#if isCollectionModalOpen}
- (isCollectionModalOpen = false)} />
+ linkCollection(e)}
+ on:unlink={(e) => removeFromCollection(e)}
+ on:close={() => (isCollectionModalOpen = false)}
+ linkedCollectionList={adventure.collections}
+ />
{/if}
{#if isWarningModalOpen}
@@ -115,108 +176,172 @@
{/if}
-
+
+
+
-
-
+
+
+
+ {adventure.is_visited ? $t('adventures.visited') : $t('adventures.planned')}
+
+ {#if unlinked}
+
{$t('adventures.out_of_range')}
+ {/if}
+
+
+
+
+
+
+ {#if adventure.category}
+
+
+ {adventure.category.display_name}
+ {adventure.category.icon}
+
+
+ {/if}
+
+
+
+
+
+
goto(`/adventures/${adventure.id}`)}
- class="text-2xl font-semibold -mt-2 break-words text-wrap hover:underline text-left"
+ class="text-xl font-bold text-left hover:text-primary transition-colors duration-200 line-clamp-2 group-hover:underline"
>
{adventure.name}
-
-
-
{$t(`adventures.activities.${adventure.type}`)}
-
- {adventure.is_visited ? $t('adventures.visited') : $t('adventures.planned')}
-
-
- {adventure.is_public ? $t('adventures.public') : $t('adventures.private')}
-
-
- {#if adventure.location && adventure.location !== ''}
-
-
-
{adventure.location}
-
- {/if}
- {#if adventure.visits.length > 0}
-
-
-
-
- {adventure.visits.length}
- {adventure.visits.length > 1 ? $t('adventures.visits') : $t('adventures.visit')}
-
-
- {/if}
- {#if adventure.activity_types && adventure.activity_types.length > 0}
-
- {#each activityTypes as activity}
-
- {activity}
-
- {/each}
-
- {/if}
-
-
- {#if type != 'link'}
- {#if adventure.user_id == user?.pk || (collection && user && collection.shared_with.includes(user.uuid))}
-
-
-
-
-
- goto(`/adventures/${adventure.id}`)}
- >
-
-
-
- {#if adventure.collection && user?.pk == adventure.user_id}
-
+ {adventure.location}
+
+ {/if}
+
+
+ {#if adventure.rating}
+
+
+ {#each renderStars(adventure.rating) as filled}
+ {#if filled}
+
+ {:else}
+
{/if}
- {#if !adventure.collection}
-
(isCollectionModalOpen = true)}
- >
+
({adventure.rating}/5)
+
+ {/if}
+
+ {formatVisitCount()}
+
+ {/if}
+
+
+ {#if !readOnly}
+
+ {#if type != 'link'}
+
+
goto(`/adventures/${adventure.id}`)}
+ >
+
+
+ {#if adventure.user_id == user?.uuid || (collection && user && collection.shared_with?.includes(user.uuid))}
+
+
+
+
+
- {/if}
- (isWarningModalOpen = true)}
- >
-
+
+
+
+
+
+ {#if user?.uuid == adventure.user_id}
+
+ (isCollectionModalOpen = true)}
+ class="flex items-center gap-2"
+ >
+
+
+ {/if}
+
+
+
+ (isWarningModalOpen = true)}
+ >
+
+
+
+
+ {/if}
{:else}
-
goto(`/adventures/${adventure.id}`)}>
+
+
{/if}
- {/if}
- {#if type == 'link'}
-
- {/if}
-
+ {/if}
+
+
diff --git a/frontend/src/lib/components/AdventureLink.svelte b/frontend/src/lib/components/AdventureLink.svelte
index db02e4e..d967093 100644
--- a/frontend/src/lib/components/AdventureLink.svelte
+++ b/frontend/src/lib/components/AdventureLink.svelte
@@ -1,5 +1,4 @@
-
+
-
-
{$t('adventures.my_adventures')}
+
+
+
+
+
+
+
+
+ {$t('adventures.my_adventures')}
+
+
+ {filteredAdventures.length}
+ {$t('worldtravel.of')}
+ {totalAdventures}
+ {$t('navbar.adventures')}
+
+
+
+
+
+
+
+
+
{$t('collection.available')}
+
{totalAdventures}
+
+
+
{$t('adventures.visited')}
+
{visitedAdventures}
+
+
+
+
+
+
+
+
+
+
+
+
+ (searchQuery = '')}
+ >
+
+ {/if}
+
+
+ {#if searchQuery || filterOption !== 'all'}
+
+
+ {/if}
+
+
+
+
+
+ {$t('worldtravel.filter_by')}:
+
+
+
(filterOption = 'all')}
+ >
+
+
(filterOption = 'visited')}
+ >
+
+
(filterOption = 'not_visited')}
+ >
+
+
(filterOption = 'public')}
+ >
+
+
(filterOption = 'private')}
+ >
+
+
+
+
+
+
{#if isLoading}
-
-
+
+
+
+
+ {$t('adventures.loading_adventures')}
+
+
+ {:else}
+
+
+ {#if filteredAdventures.length === 0}
+
+
+ {#if searchQuery || filterOption !== 'all'}
+
+ {$t('adventures.no_adventures_found')}
+
+
+ {$t('collection.try_different_search')}
+
+
+
+ {:else}
+
+ {$t('adventures.no_linkable_adventures')}
+
+
+ {$t('adventures.all_adventures_already_linked')}
+
+ {/if}
+
+ {:else}
+
+
+ {#each filteredAdventures as adventure}
+
+ {/each}
+
+ {/if}
{/if}
-
- {#each adventures as adventure}
-
- {/each}
- {#if adventures.length === 0 && !isLoading}
-
- {$t('adventures.no_linkable_adventures')}
-
- {/if}
+
+
+
+
+
+ {filteredAdventures.length}
+ {$t('adventures.adventures_available')}
+
+
+
+
-
{$t('about.close')}
diff --git a/frontend/src/lib/components/AdventureModal.svelte b/frontend/src/lib/components/AdventureModal.svelte
index 4c77a99..504a360 100644
--- a/frontend/src/lib/components/AdventureModal.svelte
+++ b/frontend/src/lib/components/AdventureModal.svelte
@@ -1,46 +1,105 @@
@@ -439,7 +523,8 @@
- {$t('adventures.name')} {$t('adventures.name')}*
- {$t('adventures.category')}
- {$t('adventures.select_adventure_category')}
- {#each ADVENTURE_TYPES as type}
- {type.label}
- {/each}
-
+ {$t('adventures.category')}*
{$t('adventures.rating')}
{$t('adventures.description')}
-
+
- {$t('adventures.generate_desc')}
{wikiError}
- {#if !collection?.id}
+ {#if !adventureToEdit || (adventureToEdit.collections && adventureToEdit.collections.length === 0)}
-
-
-
- {$t('adventures.location_information')}
-
-
-
-
-
{$t('adventures.location')}
-
- (adventure.location = reverseGeocodePlace?.display_name)}
- >{$t('adventures.set_to_pin')}
- {/if}
-
-
-
-
-
-
- {#if places.length > 0}
-
-
{$t('adventures.search_results')}
-
-
- {#each places as place}
- {
- markers = [
- {
- lngLat: { lng: Number(place.lon), lat: Number(place.lat) },
- location: place.display_name,
- name: place.name,
- activity_type: place.type
- }
- ];
- }}
- >
- {place.display_name}
-
- {/each}
-
-
- {:else if noPlaces}
-
{$t('adventures.no_results')}
- {/if}
-
-
-
-
-
- {#if reverseGeocodePlace}
-
-
{reverseGeocodePlace.region}, {reverseGeocodePlace.country}
-
- {reverseGeocodePlace.is_visited
- ? $t('adventures.visited')
- : $t('adventures.not_visited')}
-
-
- {#if !reverseGeocodePlace.is_visited}
-
-
-
-
{$t('adventures.mark_region_as_visited', {
- values: {
- region: reverseGeocodePlace.region,
- country: reverseGeocodePlace.country
- }
- })}
-
- {$t('adventures.mark_visited')}
-
-
- {/if}
- {/if}
-
-
-
+
-
-
-
- {$t('adventures.visits')} ({adventure.visits.length})
-
-
-
- {#if adventure.collection && collection && collection.start_date && collection.end_date}
- {$t('adventures.date_constrain')}
-
-
- {#if !constrainDates}
-
-
-
-
-
-
-
- {$t('adventures.add')}
-
-
- {#if adventure.visits.length > 0}
-
{$t('adventures.my_visits')}
- {#each adventure.visits as visit}
-
-
-
- {new Date(visit.start_date).toLocaleDateString(undefined, {
- timeZone: 'UTC'
- })}
-
- {#if visit.end_date && visit.end_date !== visit.start_date}
-
- {new Date(visit.end_date).toLocaleDateString(undefined, {
- timeZone: 'UTC'
- })}
-
- {/if}
-
-
- {
- adventure.visits = adventure.visits.filter((v) => v !== visit);
- }}
- >
- {$t('adventures.remove')}
-
-
-
-
{visit.notes}
-
- {/each}
- {/if}
-
-
+
@@ -872,93 +691,234 @@ it would also work to just use on:click on the MapLibre component itself. -->
{$t('adventures.warning')}: {warningMessage}
{/if}
-
{$t('adventures.save_next')}
-
{$t('about.close')}
+
+ {#if !isLoading}
+ {$t('adventures.save_next')}
+ {:else}
+ {$t('about.close')}
+
{$t('adventures.upload_images_here')}
-
-
-
{$t('adventures.image')}
-
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+:::
+
+::: details 📋 **Detailed Adventure Logs**
+Capture rich details for every adventure: name, dates, precise locations, vivid descriptions, personal ratings, photos, and customizable categories. Your memories deserve to be more than just map pins — keep them alive with full, organized logs.
+
+:::
+
+::: details 🗺️ **Interactive World Map**
+Track every destination you’ve visited or plan to visit with our beautifully detailed, interactive world map. Easily filter locations by visit status — visitedor planned — and add new adventures by simply clicking on the map. Watch your travel story unfold visually as your journey grows.
+
+:::
+
+::: details ✈️ **Comprehensive Trip Planning**
+Organize your multi-day trips with detailed itineraries, including flight information, daily activities, collaborative notes, packing checklists, and handy resource links. Stay on top of your plans and ensure every adventure runs smoothly.
+
+:::
+
+::: details 📊 **Travel Statistics Dashboard**
+Unlock insights into your travel habits and milestones through elegant, easy-to-understand analytics. Track total countries visited, regions explored, cities logged, and more. Visualize your world travels with ease and celebrate your achievements.
+
+:::
+
+::: details ✏️ **Edit & Customize Adventures**
+Make quick updates or deep customizations to any adventure using a clean and intuitive editing interface. Add photos, update notes, adjust dates, and more—keeping your records accurate and personal.
+
+:::
+
+::: details 🌍 **Countries & Regions Explorer**
+Explore and manage the countries you’ve visited or plan to visit with an organized list, filtering by visit status. Dive deeper into each country’s regions, complete with interactive maps to help you visually select and track your regional travels.
+
+
+:::
+
+## 💬 What People Are Saying
+
+::: details ✈️ **XDA Travel Week Reviews**
+
+> “I stumbled upon AdventureLog. It's an open-source, self-hosted travel planner that's completely free to use and has a bunch of cool features that make it a treat to plan, organize, and log your journey across the world. Safe to say, it's become a mainstay in Docker for me.”
+>
+> — _Sumukh Rao, Senior Author at XDA_
+
+[Article Link](https://www.xda-developers.com/i-self-hosted-this-app-to-plan-itinerary-when-traveling/)
+
+:::
+
+::: details 🧳 **Rich Edmonds, XDA**
+
+**Overall Ranking: #1**
+
+> “The most important part of travelling in this socially connected world is to log everything and showcase all of your adventures. AdventureLog is aptly named, as it allows you to do just that. It just so happens to be one of the best apps for the job and can be fully self-hosted at home.”
+>
+> — _Rich Edmonds, Lead PC Hardware Editor at XDA_
+
+[Article Link](https://www.xda-developers.com/these-self-hosted-apps-are-perfect-for-those-on-the-go/)
+
+:::
+
+::: details 📆 **Open Source Daily**
+
+> “Your travel memories are your personal treasures—don’t let them be held hostage by closed platforms, hidden fees, or privacy risks. AdventureLog represents a new era of travel tracking: open, private, comprehensive, and truly yours. Whether you’re a casual traveler, digital nomad, family vacation planner, or anyone who values their adventures, AdventureLog offers a compelling alternative that puts you back in control.”
+>
+> — _Open Source Daily_
+
+[Article Link](https://opensourcedaily.blog/adventurelog-private-open-source-travel-tracking-trip-planning/)
+
+:::
+
+## 🏗️ Built With Excellence
+
+