From c12177d887ae0a5f6ba12cf003d8d0539b6903db Mon Sep 17 00:00:00 2001 From: Hamza Ahmed Date: Mon, 5 Oct 2026 11:22:50 +0100 Subject: [PATCH] cleaner formatting and wording in places --- DECISIONS.md | 42 +++++++----------------------------------- README.md | 41 +++++++++++++++++++---------------------- 2 files changed, 26 insertions(+), 57 deletions(-) diff --git a/DECISIONS.md b/DECISIONS.md index bfecb0d..2c401f3 100644 --- a/DECISIONS.md +++ b/DECISIONS.md @@ -2,39 +2,11 @@ A file describing tech stack / feature decisions. sort of a change log -## The Birth of the project - 2026-10-05 +## 2026-10-05 — The Birth of the Project -### Languages: - -#### Backend - -##### GO - -The language I want to learn - -#### Web Frameworks - -##### HTMX - -Server side rendering reducing the number of roundtrips a user has to make to the server. The server still has to make the same number -of API calls however from the client side it should take less bandwidth and feel quicker - -#### Web Frontend - -##### HTML - -standard web building blocks, no framework chosen yet - -##### CSS - -standard web building blocks, no framework chosen yet - -##### JS - -standard web building blocks, no framework chosen yet - -### DB - -##### PostgreSQL - -Scales better than something like SQLite at the cost of more learning overhead and setup +| Area | Choice | Reasoning | +| ------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| Backend | Go | Language I want to learn | +| Web framework | HTMX | Server-side rendering reduces client-side roundtrip complexity; same API calls happen server-side but feels quicker/lighter on the client | +| Frontend | HTML/CSS/JS | Standard building blocks, no framework chosen yet | +| Database | PostgreSQL | Scales better than SQLite, at the cost of more setup/learning overhead | diff --git a/README.md b/README.md index 3c70913..7c2af56 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,41 @@ # Backslash -## A Backlog tracker. +_A Backlog tracker._ STATUS: Pre-Development -A self-hosted backlog tracker that enables you to import content, organize, create lists, add notes to lists or individual items, -leave reviews and ratings and track progress. As this progresses more features will be added of course. +A self-hosted backlog tracker that enables you to import content, organize, create lists, add notes to lists or individual items, leave reviews and ratings and track progress. +As this progresses more features will be added of course. The end goal is to create a system that allows you to track multiple media types: Books, movies, TV Shows and games etc -To begin I will create the system focused on games, the reason being I want to create this system to I can track my game backlog -as well as wanting to interact with steam and play around with importing media. +To begin I will create the system focused on games, the reason being I want to create this system to I can track my game backlog as well as wanting to interact with steam and play around with importing media. -There are other options out there that are much better and established but I want to give this project a go in an attempt to improve -my programming skills and get more exposure to full stack development. By no means am I a programmer, In my day job im an Infrastructure -Operations Engineer so Im likely way out of my depth here but here goes xD +There are other options out there that are much better and established but I want to give this project a go in an attempt to improve my programming skills. +By no means am I a programmer, In my day job im an Infrastructure Operations Engineer so Im likely way out of my depth here but here goes xD -My Goal is to create this project with minimal use of AI, I will restrict AI usage to asking questions and brainstorming ideas and best practices, -again the goal here is for me to learn programming. +My Goal is to create this project with minimal use of AI, I will restrict AI usage to asking questions and brainstorming ideas and best practices, again the goal here is for me to learn programming. -## Screenshots and Project Demos +## Screenshots and Demo -TBC +TBC — no working prototype yet. ## Getting started -as of right now there is no working program, not even a prototype :D +As of right now there is no working program, not even a prototype :D ### Docker Compose -TBC once a working prototype exists +TBC once a working prototype exists. ### Kubernetes -TBC once a working prototype exists +TBC once a working prototype exists. ## Tech stack I want to write the program in go, for no other reason than thats the language I want to learn. -architectural decisions will be made and change as I go this can be tracked in [DECISIONS.md](DECISIONS.md), -as needs and requirements change. Im stepping into this blind so continued research is required. +architectural decisions will be made and change as I go this can be tracked in [DECISIONS.md](DECISIONS.md), as needs and requirements change. +Im stepping into this blind so continued research is required. ## Contributions @@ -50,9 +47,9 @@ Will begin with basic functionality and focus on game management with imports fr ## Data storage & Privacy -As this is selfhosted you are responsible for all data you hold using this project. Please be mindful of other users you may have using the system once the project evolves -to allow that. I have no idea about best practices when it comes to writing programs that deal with sensitive data such as API keys or PII, I will try to make sure security -privacy take the forefront when it comes to data storage and privacy. +As this is selfhosted you are responsible for all data you hold using this project. +Please be mindful of other users you may have using the system once the project evolves to allow that. +I have no idea about best practices when it comes to writing programs that deal with sensitive data such as API keys or PII, I will try to make sure security and privacy take the forefront when it comes to data storage and privacy. ## Desired Features @@ -97,6 +94,6 @@ privacy take the forefront when it comes to data storage and privacy. - [ ] Public recommendations from external lists such as imdb - [ ] recommendations based on steam sale / steam wishlist (default off) -## License - AGPL-3.0 +## License -see license file [LICENSE](LICENSE). +Backslash is licensed under the GNU AGPL-3.0. See [LICENSE](LICENSE) for the full text.