This commit is contained in:
Anton Afanasyeu
2026-06-23 12:21:13 +02:00
commit ca4d54fa18
30 changed files with 1400 additions and 0 deletions

43
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,43 @@
# Contributing — url-shortener
Standalone service. **All API and deploy code changes happen in this repository**, not as loose files in the android_cast monorepo.
**Remote:** `git://f0xx.org/androidcast_project/url-shortener`
**Default branch:** `next`
## Workflow
```bash
cd backend/url-shortener # when cloned as submodule
git checkout next
git pull origin next
# develop …
./scripts/run-php-tests.sh
export BEARER=… ./scripts/smoke_shorten.sh
git add -A
git commit -m "your message"
git push origin next
```
Then in the **android_cast** parent repo:
```bash
cd ../.. # monorepo root
git add backend/url-shortener
git commit -m "Bump url-shortener submodule"
git push origin <branch>
```
## Deploy (BE)
See [DEPLOY.md](DEPLOY.md). Sync this tree to `/var/www/localhost/htdocs/apps/s/` — no crashes-console PHP required for the public API.
## Hub admin
Operator UI (mint bearer, list links) is in the monorepo: `examples/crash_reporter/backend/?view=short_links`. That code talks to the same MariaDB `url_shortener` schema; it is **not** part of this repo.
## Docs
Normative SPEC/DR live in the monorepo (`docs/specs/20100611_3_url_shortener.md`). This repo ships implementation + OpenAPI + deploy snippets only.