You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -58,8 +57,6 @@ A single-region, production-oriented URL shortener built with Spring Boot and An
58
57
| --- | --- | --- |
59
58
|`POST`|`/api/urls`| Shorten a URL |
60
59
|`GET`|`/{shortCode}`| Redirect to original URL |
61
-
|`GET`|`/actuator/health`| Health check |
62
-
|`GET`|`/actuator/prometheus`| Metrics |
63
60
64
61
---
65
62
@@ -69,29 +66,23 @@ A single-region, production-oriented URL shortener built with Spring Boot and An
69
66
70
67
- Docker & Docker Compose
71
68
- Java 21 (for running backend without Docker)
72
-
- Node 20+ (for running frontend without Docker)
73
69
74
70
### Full stack (backend + database + nginx)
75
71
76
72
```bash
77
-
# Copy and fill in required env vars
78
-
cp .env.example .env
79
-
80
73
docker compose up --build
81
74
```
82
75
83
76
App available at `http://localhost:8080`.
84
77
85
-
### Backend only (with local Postgres)
78
+
### Backend only
86
79
87
80
```bash
88
81
cd tinyurl
89
82
./gradlew bootRun
90
83
```
91
84
92
-
Backend runs on `http://localhost:8080` by default.
93
-
94
-
### Run backend tests
85
+
### Run tests
95
86
96
87
```bash
97
88
cd tinyurl
@@ -102,17 +93,6 @@ cd tinyurl
102
93
103
94
---
104
95
105
-
## Environments
106
-
107
-
| Environment | How to run | URL |
108
-
| --- | --- | --- |
109
-
| Local (full stack) |`docker compose up` from repo root |`http://localhost:8080`|
110
-
| Local (backend only) |`./gradlew bootRun` in `tinyurl/`|`http://localhost:8080`|
111
-
| Local (frontend dev) | See [tinyurl-gui/README.md](tinyurl-gui/README.md)|`http://localhost:4200`|
112
-
| Production | Auto-deploy on merge to `main`|[go.buffden.com](https://go.buffden.com)|
113
-
114
-
---
115
-
116
96
## Project Structure
117
97
118
98
```text
@@ -123,23 +103,13 @@ infra/
123
103
postgres/ # DB init scripts
124
104
docs/
125
105
architecture/ # ADRs and architecture docs
126
-
deployment/ # AWS deployment phases (A–F)
106
+
deployment/ # AWS deployment runbook (phases A–F)
127
107
diagrams/ # Architecture diagrams (SVG)
128
108
docker-compose.yml # Local dev stack
129
-
docker-compose.prod.yml # Production stack (no Postgres — uses RDS)
130
109
```
131
110
132
111
---
133
112
134
113
## Deployment
135
114
136
-
Production runs on AWS (`us-east-1`). See [`docs/deployment/`](docs/deployment/README.md) for the full deployment runbook (infrastructure provisioning, secrets, CI/CD, observability, hardening).
0 commit comments