ahmza.com/backslash
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cleaner formatting and wording in places

Browse Source
This commit is contained in:
ahmza
2026-10-05 11:22:50 +01:00
parent 8cb92263d5
commit c12177d887
2 changed files with 26 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DECISIONS.md
+7 -35
View File
@@ -2,39 +2,11 @@
A file describing tech stack / feature decisions. sort of a change log 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: | Area | Choice | Reasoning |
| ------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
#### Backend | 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 |
##### GO | 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 |
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
README.md
+19 -22
View File
@@ -1,44 +1,41 @@
# Backslash # Backslash
## A Backlog tracker. _A Backlog tracker._
STATUS: Pre-Development STATUS: Pre-Development
A self-hosted backlog tracker that enables you to import content, organize, create lists, add notes to lists or individual items, 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.
leave reviews and ratings and track progress. As this progresses more features will be added of course. 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 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 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.
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 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.
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 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
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, 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.
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 ## 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 ### Docker Compose
TBC once a working prototype exists TBC once a working prototype exists.
### Kubernetes ### Kubernetes
TBC once a working prototype exists TBC once a working prototype exists.
## Tech stack ## Tech stack
I want to write the program in go, for no other reason than thats the language I want to learn. 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), architectural decisions will be made and change as I go this can be tracked in [DECISIONS.md](DECISIONS.md), as needs and requirements change.
as needs and requirements change. Im stepping into this blind so continued research is required. Im stepping into this blind so continued research is required.
## Contributions ## Contributions
@@ -50,9 +47,9 @@ Will begin with basic functionality and focus on game management with imports fr
## Data storage & Privacy ## 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 As this is selfhosted you are responsible for all data you hold using this project.
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 Please be mindful of other users you may have using the system once the project evolves to allow that.
privacy take the forefront when it comes to data storage and privacy. 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 ## 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 - [ ] Public recommendations from external lists such as imdb
- [ ] recommendations based on steam sale / steam wishlist (default off) - [ ] 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.