luxick/chronological
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
luxick
2025-12-10 10:33:36 +01:00
parent e0c299279e
commit cff9defc4a
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -7,6 +7,7 @@ Days with events, journal entries or photos are highlighted with a corresponding
The right side shows a detailed, scrollable timeline view of the selected month, with all events, journal entries and photos displayed in chronological order. The right side shows a detailed, scrollable timeline view of the selected month, with all events, journal entries and photos displayed in chronological order.
From either the calendar grid or the timeline view, the user can click on a specific day to see more details or add new entries. From either the calendar grid or the timeline view, the user can click on a specific day to see more details or add new entries.
## Technical Details ## Technical Details
## General Information
- Build using go and HTMX. - Build using go and HTMX.
- Single user application without any login or authentication. - Single user application without any login or authentication.
- App uses server-side rendering with HTMX for dynamic updates. - App uses server-side rendering with HTMX for dynamic updates.
@@ -29,4 +30,9 @@ From either the calendar grid or the timeline view, the user can click on a spec
- The description field of that all-day event contains the actual journal text. - The description field of that all-day event contains the actual journal text.
## Frontend ## Frontend
- The frontend is built using HTMX for dynamic content updates. - The frontend is built using HTMX for dynamic content updates.
- TODO: It is not yet deceided what CSS framework to use, if any. - TODO: It is not yet deceided what CSS framework to use, if any.
## Deployment
- The application is compiled into a single binary (plus a config file) for easy deployment.
- Configuration is done via a config file that is read at startup.
- The application can be run as a standalone server on a specified port.
- Static files (CSS, JS, images) are inculeded in the binary using Go's embed package.