Add screenshots and better documentation

README.md

@@ -1,10 +1,23 @@
 # AdventureLog: Embark, Explore, Remember. 🌍
 
-_**⚠️ AdventureLog is in early development and is not recommended for production use until version 1.0!**_
-
 ### _"Never forget an adventure with AdventureLog - Your ultimate travel companion!"_
 
----
+**Documentation can be found [here](https://docs.adventurelog.app).**
+
+# Table of Contents
+
+- [Installation](#installation)
+  - [Docker 🐋](#docker-)
+    - [Prerequisites](#prerequisites)
+    - [Getting Started](#getting-started)
+    - [Configuration](#configuration)
+      - [Frontend Container (web)](#frontend-container-web)
+      - [Backend Container (server)](#backend-container-server)
+      - [Proxy Container (nginx) Configuration](#proxy-container-nginx-configuration)
+    - [Running the Containers](#running-the-containers)
+- [Screenshots 🖼️](#screenshots)
+- [About AdventureLog](#about-adventurelog)
+- [Attribution](#attribution)
 
 # Installation
 
@@ -82,6 +95,27 @@ docker compose up -d
 
 Enjoy AdventureLog! 🎉
 
+# Screenshots
+
+![Adventure Page](screenshots/adventures.png)
+Displaying the adventures you have visited and the ones you plan to embark on. You can also filter and sort the adventures.
+
+![Detail Page](screenshots/details.png)
+Shows specific details about an adventure, including the name, date, location, description, and rating.
+
+![Edit](screenshots/edit.png)
+
+![Map Page](screenshots/map.png)
+View all of your adventures on a map, with the ability to filter by visit status and add new ones by click on the map.
+
+![Itinerary Page](screenshots/itinerary.png)
+
+![Country Page](screenshots/countries.png)
+
+![Region Page](screenshots/regions.png)
+
+️
+
 # About AdventureLog
 
 AdventureLog is a Svelte Kit and Django application that utilizes a PostgreSQL database. Users can log the adventures they have experienced, as well as plan future ones. Key features include:

docker-compose.yml

@@ -8,9 +8,7 @@ services:
       - PUBLIC_SERVER_URL=http://server:8000
       - ORIGIN=http://localhost:8080
       - BODY_SIZE_LIMIT=Infinity
-      # Analytics can be configured here using Umami (https://umami.is)
       - ENABLE_ANALYTICS=false
-      #- UNAMI_KEY=''
     ports:
       - "8080:3000"
     depends_on:
@@ -60,14 +58,3 @@ services:
 volumes:
   postgres_data:
   adventurelog_media:
-#
-# nginx:
-#     build:
-#       context: ./proxy/
-#       dockerfile: Dockerfile.nginx
-#     ports:
-#       - "81:80" # Using port 81 to avoid conflict with your existing setup
-#     volumes:
-#       - adventurelog_media:/app/media
-#     depends_on:
-#       - server

documentation/blog/2019-05-28-first-blog-post.md

@@ -1,12 +0,0 @@
----
-slug: first-blog-post
-title: First Blog Post
-authors:
-  name: Gao Wei
-  title: Docusaurus Core Team
-  url: https://github.com/wgao19
-  image_url: https://github.com/wgao19.png
-tags: [hola, docusaurus]
----
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

documentation/blog/2019-05-29-long-blog-post.md

@@ -1,44 +0,0 @@
----
-slug: long-blog-post
-title: Long Blog Post
-authors: endi
-tags: [hello, docusaurus]
----
-
-This is the summary of a very long blog post,
-
-Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
-
-<!--truncate-->
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

documentation/blog/2021-08-01-mdx-blog-post.mdx

@@ -1,20 +0,0 @@
----
-slug: mdx-blog-post
-title: MDX Blog Post
-authors: [slorber]
-tags: [docusaurus]
----
-
-Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
-
-:::tip
-
-Use the power of React to create interactive blog posts.
-
-```js
-<button onClick={() => alert('button clicked!')}>Click me!</button>
-```
-
-<button onClick={() => alert('button clicked!')}>Click me!</button>
-
-:::

documentation/blog/2021-08-26-welcome/index.md

@@ -1,25 +0,0 @@
----
-slug: welcome
-title: Welcome
-authors: [slorber, yangshun]
-tags: [facebook, hello, docusaurus]
----
-
-[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
-
-Simply add Markdown files (or folders) to the `blog` directory.
-
-Regular blog authors can be added to `authors.yml`.
-
-The blog post date can be extracted from filenames, such as:
-
-- `2019-05-30-welcome.md`
-- `2019-05-30-welcome/index.md`
-
-A blog post folder can be convenient to co-locate blog post images:
-
-![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
-
-The blog supports tags as well!
-
-**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

documentation/docs/Installation/local.md

@@ -1,5 +0,0 @@
----
-sidebar_position: 2
----
-
-# Local 🖥️

documentation/docusaurus.config.ts

@@ -4,7 +4,7 @@ import type * as Preset from "@docusaurus/preset-classic";
 
 const config: Config = {
   title: "Adventure Log",
-  tagline: "AdventureLog: Embark, Explore, Remember. 🌍",
+  tagline: "Embark, Explore, Remember. 🗺️",
   favicon: "img/favicon.png",
 
   // Set the production url of your site here
@@ -42,13 +42,13 @@ const config: Config = {
           editUrl:
             "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
         },
-        blog: {
+        // blog: {
-          showReadingTime: true,
+        //   showReadingTime: true,
-          // Please change this to your repo.
+        //   // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
+        //   // Remove this to remove the "edit this page" links.
-          editUrl:
+        //   editUrl:
-            "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
+        //     "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
-        },
+        // },
         theme: {
           customCss: "./src/css/custom.css",
         },
@@ -77,7 +77,7 @@ const config: Config = {
           position: "left",
           label: "Documentation",
         },
-        { to: "/blog", label: "Blog", position: "left" },
+        // { to: "/blog", label: "Blog", position: "left" },
         {
           href: "https://github.com/seanmorley15/adventurelog",
           label: "GitHub",
@@ -95,40 +95,32 @@ const config: Config = {
               label: "Intro",
               to: "/docs/intro",
             },
+            {
+              label: "Installation",
+              to: "/docs/Installation/docker",
+            },
           ],
         },
         {
           title: "Community",
           items: [
-            {
-              label: "Stack Overflow",
-              href: "https://stackoverflow.com/questions/tagged/docusaurus",
-            },
-            {
-              label: "Discord",
-              href: "https://discordapp.com/invite/docusaurus",
-            },
-            {
-              label: "Twitter",
-              href: "https://twitter.com/docusaurus",
-            },
-          ],
-        },
-        {
-          title: "More",
-          items: [
-            {
-              label: "Blog",
-              to: "/blog",
-            },
             {
               label: "GitHub",
-              href: "https://github.com/facebook/docusaurus",
+              href: "https://github.com/seanmorley15/adventurelog",
             },
           ],
         },
+        // {
+        //   title: "More",
+        //   items: [
+        //     {
+        //       label: "Blog",
+        //       to: "/blog",
+        //     },
+        //   ],
+        // },
       ],
-      copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
+      copyright: `Copyright © ${new Date().getFullYear()} Sean Morley Built with Docusaurus.`,
     },
     prism: {
       theme: prismThemes.github,