{"id":22957894,"url":"https://github.com/suraj-encoding/shortify","last_synced_at":"2026-04-15T05:31:32.827Z","repository":{"id":255461800,"uuid":"848298471","full_name":"Suraj-Encoding/Shortify","owner":"Suraj-Encoding","description":"🕸️ Shortify - Modern  URL Shortener 🕸️","archived":false,"fork":false,"pushed_at":"2026-01-06T11:46:32.000Z","size":659,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2026-01-08T19:54:14.793Z","etag":null,"topics":["clerk","full-stack","go","mongodb","nextjs","render","shortify","url-shortener","vercel"],"latest_commit_sha":null,"homepage":"https://myshortify.vercel.app","language":"JavaScript","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/Suraj-Encoding.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":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-27T14:03:27.000Z","updated_at":"2026-01-06T11:43:51.000Z","dependencies_parsed_at":"2024-12-14T17:37:58.535Z","dependency_job_id":null,"html_url":"https://github.com/Suraj-Encoding/Shortify","commit_stats":null,"previous_names":["suraj-encoding/shortify"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Suraj-Encoding/Shortify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-Encoding%2FShortify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-Encoding%2FShortify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-Encoding%2FShortify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-Encoding%2FShortify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Suraj-Encoding","download_url":"https://codeload.github.com/Suraj-Encoding/Shortify/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-Encoding%2FShortify/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31828530,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T18:05:02.291Z","status":"online","status_checked_at":"2026-04-15T02:00:06.175Z","response_time":63,"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":["clerk","full-stack","go","mongodb","nextjs","render","shortify","url-shortener","vercel"],"created_at":"2024-12-14T17:27:18.662Z","updated_at":"2026-04-15T05:31:32.812Z","avatar_url":"https://github.com/Suraj-Encoding.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- # \"Shortify\" Readme File # --\u003e\n# 🕸️ Welcome to Shortify - Modern URL Shortener 🕸️\n\nShortify is a modern, full‑stack URL shortening service built with Go (backend), MongoDB (data store), Clerk (authentication), and Next.js (frontend). It's designed for rapid development and production readiness with clean APIs and a polished UI.\n\n---\n\n## 🚀 Live Deployments\n\n- 🌐 **Frontend (Vercel)**  \n  👉 https://myshortify.vercel.app\n\n- ⚙️ **Backend (Render)**  \n  👉 https://shortwave.onrender.com\n\n---\n\n## Tech Stack\n\n- **Backend:** Go\n- **Database:** MongoDB\n- **Auth:** Clerk\n- **Frontend:** Next.js\n\n---\n\n## Key Features\n\n- Shorten URLs into vanity links (username + slug)\n- Fast redirect service for shortened links\n- User management and authentication via Clerk\n- MongoDB for reliable storage of users and links\n- Next.js frontend with responsive UI and Clerk integration\n\n---\n\n## Project Structure (high level)\n\n- `Server/` — Go backend, API handlers, app logic and MongoDB integration\n- `Client/` — Next.js frontend, components, and Clerk auth routes\n- `README.md` — This file\n\n---\n\n## Quick Start\n\nPrerequisites:\n\n- Go 1.20+ installed\n- MongoDB accessible (local or hosted)\n- Clerk account and API keys (for auth)\n\n1. Clone the repo\n\n```bash\nmkdir Shortify\ncd Shortify\ngit clone https://github.com/\u003cyour-github-username\u003e/Shortify.git .\n```\n\n2. Configure application settings (local \u0026 production)\n\nBefore running the app locally or deploying, make sure your runtime configuration is in place:\n\n- Local development: copy `Server/.env.example` to `Server/.env` and `Client/.env.example` to `Client/.env`, then open those files and fill in values specific to your environment. Keep sensitive values out of version control.\n\n- Production: configure required settings and secrets in your hosting platform's environment manager (Vercel, Render, etc.). Ensure callback/webhook URLs (for Clerk and other services) point to your deployed URLs.\n\nUse the example files in `Server/.env.example` and `Client/.env.example` as the authoritative list of keys to provide; the README avoids enumerating individual variable names to keep configuration details centralized in the example files.\n\n3. Run the backend\n\n```bash\ncd Server\ngo mod tidy\ngo build main.go\n./main\n```\n\n4. Frontend: install and run\n\n```bash\ncd Client\nnpm install\nnpm run build \nnpm run dev\n```\n\nThe frontend typically runs on `http://localhost:3000` and the backend on `http://localhost:3001` (configurable).\n\n---\n\n## Common Endpoints\n\n- Redirect (public): `GET /{username}/{slug}` — redirects to the destination URL of the link\n- API base: `/api/v1`\n  - User webhook: `POST /api/v1/user/webhook` (Clerk)\n  - Update username: `PUT /api/v1/user/username`\n  - Links CRUD: under `/api/v1/link`\n\n---\n\n## Testing \u0026 Development Tips\n\n- Use `curl -v http://localhost:3001/username/slug` to test redirects.\n- Run `go build main.go` to check for backend compile errors.\n- Ensure Clerk webhooks point to the server's `/api/v1/user/webhook` during integration.\n\n---\n\n## Deployment\n\nBelow are quick deployment flows for the frontend (Vercel) and backend (Render). These are minimal steps — adapt them for your environment and secrets manager.\n\n- Vercel (Frontend)\n\n  1. Create a Vercel project and connect it to this repository.\n  2. Set the Project Root to `Client` (or import as a monorepo and point the app to `Client`).\n  3. Build command: `npm run build`\n  4. Output directory: leave default (Next.js handled by Vercel).\n  5. Configure required settings and secrets in Vercel (Dashboard → Settings → Environment Variables).\n  6. Deploy — Vercel will run builds on every push.\n\n- Render (Backend)\n\n  1. Create a new Web Service on Render and connect it to the repository.\n  2. Set the root directory to `Server`.\n  3. Environment \u0026 Build:\n    - Build command: `go build main.go`\n    - Start command: `./main`\n  4. Configure required settings and secrets in Render (Service settings → Environment).\n  5. Deploy — Render will build and start the service; check logs for startup errors.\n\nTips:\n\n- Use Vercel for the Next.js frontend (serverless/edge‑optimized) and Render (or similar) for the Go backend.\n- Keep production secrets in the platform's environment manager — never commit them.\n- If using webhooks (Clerk), configure callback URLs in Clerk to point to your deployed `POST /api/v1/user/webhook` endpoint.\n\n---\n\n## Contributing\n\nContributions welcome — open issues or submit PRs. Follow these steps:\n\n1. Fork the repo\n2. Create a feature branch\n3. Make changes and run `go build` and `npm run dev` locally\n4. Open a PR with a clear description\n\n---\n\n## License\n\nThis project uses the license in the repository. Feel free to adapt as needed.\n\n---\n\n## Acknowledgments\nEnjoy Shortify — deployment and CI-CD guidance have been added above. Open an issue or PR if you want badges, examples, or more detailed deployment templates.\n\n---","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuraj-encoding%2Fshortify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuraj-encoding%2Fshortify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuraj-encoding%2Fshortify/lists"}