From f11288d0e09f37d052b46b0267c30432c220a3a7 Mon Sep 17 00:00:00 2001 From: Kenneth Obsequio Date: Sat, 26 Sep 2026 22:08:58 +0800 Subject: [PATCH] STARR guidelines Signed-off-by: Kenneth Obsequio --- README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 5bf2420..d743015 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ # STAR Phase 1 — Tier 1 Auth System -## Technical Documentation - **Version:** 1.0.0 **Date:** October 6, 2025 **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 expect that you are in `dev/safe` branch so we recommend to have your own forked repository here's breakdown: + +``` +BRANCH_NAME | DESCRIPTION +------------------------- +main - A protected branch 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 -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 -``` +See [SELF_HOSTING.md](./SELF_HOSTING.md) for the full Docker Compose setup guide. \ No newline at end of file