mirror of
https://github.com/rgrgogu/new_starr.git
synced 2026-09-27 00:12:54 +08:00
@@ -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 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
|
||||
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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user