{"id":30454410,"url":"https://github.com/yusufakajose/myprofile","last_synced_at":"2026-04-11T05:05:26.771Z","repository":{"id":309271392,"uuid":"1035658525","full_name":"yusufakajose/MyProfile","owner":"yusufakajose","description":"Link‑in‑bio and link management platform with QR codes, analytics, and webhooks. Spring Boot + React, PostgreSQL/Redis/RabbitMQ, Dockerized with Nginx, caching and rate limiting, CI via GitHub Actions.","archived":false,"fork":false,"pushed_at":"2025-08-19T00:02:00.000Z","size":5088,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-19T02:19:45.930Z","etag":null,"topics":["docker","docker-compose","flyway","github-actions","link-in-bio","nginx","postgresql","rabbitmq","react","redis","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yusufakajose.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-10T21:36:35.000Z","updated_at":"2025-08-19T00:02:04.000Z","dependencies_parsed_at":"2025-08-11T00:24:06.905Z","dependency_job_id":null,"html_url":"https://github.com/yusufakajose/MyProfile","commit_stats":null,"previous_names":["yusufakajose/myprofile"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yusufakajose/MyProfile","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufakajose%2FMyProfile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufakajose%2FMyProfile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufakajose%2FMyProfile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufakajose%2FMyProfile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yusufakajose","download_url":"https://codeload.github.com/yusufakajose/MyProfile/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufakajose%2FMyProfile/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271755407,"owners_count":24815398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","flyway","github-actions","link-in-bio","nginx","postgresql","rabbitmq","react","redis","spring-boot"],"created_at":"2025-08-23T16:01:41.361Z","updated_at":"2025-11-01T04:04:22.347Z","avatar_url":"https://github.com/yusufakajose.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LinkGrove (MyProfile)\n\n[![CI](https://github.com/yusufakajose/MyProfile/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/yusufakajose/MyProfile/actions/workflows/ci.yml)\n\nLinkGrove is a full‑stack link profiles and analytics platform. Create a public profile with links, generate QR codes (PNG/SVG) with caching and ETags, and view analytics by referrer, device, country, source, and A/B variants. Built with Spring Boot 3 + Java 21 on the backend and React + Nginx on the frontend, backed by PostgreSQL, Redis, and RabbitMQ.\n\n## Features\n\n- QR codes: PNG/SVG, custom colors, logo overlay, robust caching (ETag/304), HEAD support\n- Public profiles: SEO meta for social previews, SPA routing via Nginx\n- Analytics: referrers, devices, countries, sources, per‑link and per‑variant timeseries\n- Rate limiting: sliding window with `X-RateLimit-*` headers and 429 handling\n- Webhooks: delivery + retry with DLQ tracking\n- Security: JWT auth, role‑based endpoints, centralized error handling\n- CI/CD: GitHub Actions, pinned container images, Testcontainers‑based tests\n\n## Tech stack\n\n- Backend: Java 21, Spring Boot 3, Spring Data JPA, Flyway, Micrometer\n- Data: PostgreSQL, Redis, RabbitMQ\n- Frontend: React, Material‑UI, Nginx\n- Tooling: Docker/Compose, Testcontainers, GitHub Actions\n\n## Quick start (Docker Compose)\n\nPrereqs: Docker + Compose plugin. For full environment templates and advanced options, see [`docs/DEV_SETUP.md`](docs/DEV_SETUP.md).\n\n1. Copy the example environment file:\n   ```bash\n   cp infra/docker/.env.example infra/docker/.env\n   ```\n   Edit `.env` as needed (defaults work for local dev; **change `JWT_SECRET` in production**).\n\n2. Start the stack:\n   ```bash\n   bash infra/docker/start.sh\n   ```\n   - App: http://localhost:3001\n   - API (proxied): http://localhost:3001/api\n\n3. Stop and clean up:\n   ```bash\n   bash infra/docker/stop.sh\n   ```\n\nSeeded demo accounts:\n- Admin: `admin` / `admin123`\n- Demo: `demo` / `password`\n\n## Configuration\n\nYou can override configuration via environment variables (recommended using `infra/docker/.env`). Key variables:\n\n- `SPRING_DATASOURCE_URL`, `SPRING_DATASOURCE_USERNAME`, `SPRING_DATASOURCE_PASSWORD`\n- `SPRING_REDIS_HOST`, `SPRING_REDIS_PORT`\n- `SPRING_RABBITMQ_HOST`, `SPRING_RABBITMQ_PORT`\n- `JWT_SECRET` (required in production)\n- `CORS_ALLOWED_ORIGINS` (e.g. `http://localhost:3001`)\n- `PUBLIC_BASE_URL` (used for public URLs/meta)\n- `REACT_APP_API_URL` (frontend build‑time; use `/api` with Nginx proxy)\n\nSee `backend/src/main/resources/application.yml` and `infra/docker/docker-compose.yml` for defaults.\n\n## Development (without Docker)\n\nBackend:\n\n```bash\ncd backend\n./mvnw -B -DskipITs=false test\n./mvnw spring-boot:run\n# API at http://localhost:8080/api\n```\n\nFrontend:\n\n```bash\ncd frontend\nREACT_APP_API_URL=http://localhost:8080/api npm start\n# App at http://localhost:3000\n```\n\n## Testing \u0026 build\n\n- Backend unit/integration tests (Testcontainers):\n\n```bash\ncd backend\n./mvnw -B -DskipITs=false test\n```\n\n- Frontend build (ESLint enforced):\n\n```bash\ncd frontend\nCI=true npm run build\n```\n\nSee [`docs/DEV_SETUP.md`](docs/DEV_SETUP.md#5-testing-cheat-sheet) for a consolidated matrix of backend/Frontend/E2E commands and troubleshooting tips.\n\n## API\n\nSee [`docs/API.md`](docs/API.md) for complete endpoint reference, request/response examples, webhook verification, and error handling.\n\nNotable endpoints:\n\n- Auth: `POST /api/auth/register`, `POST /api/auth/login`, `GET /api/auth/health`\n- Public profile: `GET /api/public/{username}`, `GET /api/public/meta/{username}`\n- Links (auth): `GET /api/links`, `POST /api/links`, updates/deletes\n- Analytics (auth): `GET /api/analytics/...` (overview, timeseries, referrers, devices, countries, sources, variants)\n- Redirect/QR: `/r/{id}`, `/r/a/{alias}`, `/r/{id}/qr.png|svg` (+ HEAD)\n\n## Observability\n\n- Health: `GET /api/auth/health`\n- Metrics (Prometheus): `GET /actuator/prometheus`\n\n## CI/CD\n\n- GitHub Actions workflow at `.github/workflows/ci.yml`\n- Status badge: [![CI](https://github.com/yusufakajose/MyProfile/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/yusufakajose/MyProfile/actions/workflows/ci.yml)\n- Developer setup badge: [![Dev Setup](https://img.shields.io/badge/docs-dev%20setup-blue)](docs/DEV_SETUP.md)\n- Pinned container images across Dockerfiles/Compose/Testcontainers for reproducible builds\n\n### Pipeline overview\n\nThe `CI` workflow runs the following jobs in order:\n\n1. `lint` — verifies no generated artifacts (`backend/target`, `frontend/build`, `*.log`) are checked in.\n2. `backend` — Maven verify (unit + integration) with Testcontainers; uploads the Spring Boot jar artifact.\n3. `frontend` — Node build; uploads the compiled React bundle.\n4. `e2e` — Playwright tests using the artifacts above, plus backend/frontend logs and reports on failure.\n\nReference the detailed setup and commands in [`docs/DEV_SETUP.md`](docs/DEV_SETUP.md#5-testing-cheat-sheet).\n\n## Troubleshooting\n\n- 502 via Nginx proxy: ensure backend is healthy; `docker compose ps` and retry\n- Redis connection errors: start Redis service; if you upgraded Redis and see `Can't handle RDB format`, run `bash infra/docker/stop.sh` to remove volumes and restart (this wipes Redis data)\n- Frontend build warnings failing CI: run `CI=true npm run build` locally to reproduce and fix ESLint\n\n## Roadmap \u0026 contributing\n\n- See `ROADMAP.md` for planned work\n- Contributions welcome: open an issue/PR. Please keep code clear and tested.\n\n## License\n\nCopyright (c) 2025. All rights reserved. If you intend to open‑source this project, add a `LICENSE` file (e.g., MIT) and update this section.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusufakajose%2Fmyprofile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyusufakajose%2Fmyprofile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusufakajose%2Fmyprofile/lists"}