STARR guidelines

Signed-off-by: Kenneth Obsequio <k80308392@gmail.com>
This commit is contained in:
2026-09-26 13:45:15 +08:00
parent 8bf4c04f0b
commit 6611af68f3
+14 -15
View File
@@ -1,21 +1,20 @@
# STAR Phase 1 — Tier 1 Auth System # STAR Phase 1 — Tier 1 Auth System
## Technical Documentation
**Version:** 1.0.0 **Version:** 1.0.0
**Date:** October 6, 2025 **Date:** October 6, 2025
**Stack:** Node.js · Express · Sequelize (PostgreSQL) · JWT · Google OAuth 2.0 · Nodemailer **Stack:** Node.js · Express · Sequelize (PostgreSQL) · JWT · Google OAuth 2.0 · Nodemailer
**Deployment** DigitalOcean Droplet (3 Droplets for API + S3 and Postgres) **Deployment** DigitalOcean Droplet (2 Droplets for API + S3 and Postgres)
## Contributing
We remind everyone to work with `dev/safe` branch and we recommend to have your own forked repository here's breakdown:
```
BRANCH_NAME | DESCRIPTION
-------------------------
main - Protected branch supposedly maintain by creators
staging-qa - Everytime na may Pull Requests (PR) from your forked repository dito mismo sa branch na ito kami mag-check per feature, per modification and also bug.
staging-uat - Supposedly has working Github Action so I will tell about it.
dev/safe - In your forked repository always use this branch
```
## Self-hosting ## Self-hosting
See [SELF_HOSTING.md](./SELF_HOSTING.md) for the full Docker Compose setup guide. See [SELF_HOSTING.md](./SELF_HOSTING.md) for the full Docker Compose setup guide.
## TODO
Branchings and Tags (Backups)
```
main (protected) → prod
qas (protected) → staging
dev (protected*) → integration/playground
feature/xyz → short-lived, deleted after merge
hotfix/xyz → for urgent prod patches
+ tags (v1.0.9...) → released snapshots
```