x/spend-sparrow
2
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

feat(docs): update readme

Browse Source
This commit is contained in:
Tim Wundenberg
2025-02-23 21:44:58 +01:00
parent 9b96e8f0a5
commit 3039d66295
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Readme.md
View File

@@ -7,11 +7,11 @@ A basic template with authentication to easily host on a VPC.
This template includes everything essential to build an app. It includes the following features:
- Authentication: Users can login, logout, register and reset their password. For increased security TOTP is available aswell.
- Authentication: Users can login, logout, register and reset their password. (for increased security TOTP is planned aswell.)
- Observability: The stack contains an Grafana+Prometheus instance for basic monitoring. You are able to add alerts and get notified on your phone.
- Mail: You are able to send mail with SMTP. You still need an external Mail Server, but a guide on how to set that up with a custom domain is included.
- SSL: This is included by using traefik as reverse proxy. It handles SSL certificates automatically. Furthermore all services are accessible through subdomains. Best thing is, you can add your more with 3 lines of code
- Actual Stack: Tailwindcss + HTMX + DaisyUI + GO Backend with templ and sqlite
- SSL: This is included by using traefik as reverse proxy. It handles SSL certificates automatically. Furthermore all services are accessible through subdomains.
- Stack: Tailwindcss + HTMX + GO Backend with templ and sqlite
## Architecture Design Decisions
@@ -51,13 +51,13 @@ Instead of implementing authentication from scratch, an external OAuth2 provider
Pros:
- The Systems of BigTech are probably safer. They have security experts employed.
- The other external system needs to prevent credential stuffing attacks, etc.
- The other external system is responsible to prevent credential stuffing attacks, etc.
- Users don't have to create new credentials
Cons:
- High dependency on those providers
- Single Point of failure (If your account is banned, your application access get's lost as well)
- It's possible that these providers ban the whole application
- There still needs to be implemented some logic server side
- Single Point of failure (If your account is banned, your application access get's lost as well.)
- It's possible that these providers ban the whole application (All users lose access)
- There still needs to be implemented some logic
- Full application integration can be difficult
#### 3. Using OAuth2 with Keycloak