mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2025-08-03 04:05:18 +02:00
Add screenshots and better documentation
This commit is contained in:
parent
ad1799b79e
commit
48b70b5bec
16 changed files with 61 additions and 154 deletions
40
README.md
40
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
|
||||
|
||||

|
||||
Displaying the adventures you have visited and the ones you plan to embark on. You can also filter and sort the adventures.
|
||||
|
||||

|
||||
Shows specific details about an adventure, including the name, date, location, description, and rating.
|
||||
|
||||

|
||||
|
||||

|
||||
View all of your adventures on a map, with the ability to filter by visit status and add new ones by click on the map.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
️
|
||||
|
||||
# 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:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue