{"id":15095971,"url":"https://github.com/nitzanpap/url-shortener","last_synced_at":"2026-04-07T19:31:10.007Z","repository":{"id":244880909,"uuid":"812659779","full_name":"nitzanpap/url-shortener","owner":"nitzanpap","description":"A simple URL shortener service, written in Go \u0026 Next.js","archived":false,"fork":false,"pushed_at":"2026-02-07T16:24:30.000Z","size":7652,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-07T23:19:05.063Z","etag":null,"topics":["gin-gonic","go","nextjs","postgresql","react","typescript"],"latest_commit_sha":null,"homepage":"https://usni.vercel.app","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nitzanpap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-09T14:22:03.000Z","updated_at":"2026-02-07T16:24:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"fe89ae86-b499-4494-a460-d2a8e302c389","html_url":"https://github.com/nitzanpap/url-shortener","commit_stats":{"total_commits":127,"total_committers":2,"mean_commits":63.5,"dds":"0.015748031496062964","last_synced_commit":"e5186da9986a85975e6dd8296e39c867791db0d6"},"previous_names":["nitzanpap/url-shortener"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/nitzanpap/url-shortener","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitzanpap%2Furl-shortener","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitzanpap%2Furl-shortener/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitzanpap%2Furl-shortener/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitzanpap%2Furl-shortener/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nitzanpap","download_url":"https://codeload.github.com/nitzanpap/url-shortener/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitzanpap%2Furl-shortener/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31526665,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"ssl_error","status_checked_at":"2026-04-07T16:28:06.951Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["gin-gonic","go","nextjs","postgresql","react","typescript"],"created_at":"2024-09-25T15:44:25.097Z","updated_at":"2026-04-07T19:31:09.998Z","avatar_url":"https://github.com/nitzanpap.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# URL Shortener\n\n## Introduction\n\nThis is a simple URL shortener project, made for learning purposes.\n\nIt is similar to Bit.ly or TinyURL, and allows users to input a long URL and receive a shortened version of it. This makes sharing links easier and helps in tracking and managing URLs.\n\n[View the live application here](https://usni.vercel.app/) 👈.\n\n## Features\n\n- **Shorten URLs:** Convert long URLs into manageable short links.\n- **Easy to use:** Simple interface for creating and managing URLs.\n- **PWA:** Easily install the application on Windows, macOS, Android, and iOS. [Click here to see how](https://www.google.com/search?q=how+to+download+pwa)\n\n## Technologies\n\n- **Backend:** Go, Gin\n- **Database:** PostgreSQL\n- **Frontend:** Next.js, TypeScript, SCSS.modules\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nWhat things you need to install the software and how to install them:\n\nFor the server:\n\n- Go: [Download and install Go](https://golang.org/doc/install)\n  - Air: [Install Air](https://github.com/air-verse/air?tab=readme-ov-file#installation) if you want to use live reload\n- PostgreSQL: [Download and install PostgreSQL](https://www.postgresql.org/download/)\n\nFor the client:\n\n- Bun: [Download and install Bun](https://bun.sh/docs/installation)\n\n### Installing\n\nA step by step series of examples that tell you how to get a development env running:\n\n1. Clone the repository:\n\n    ```bash\n    git clone github.com/nitzanpap/url-shortener\n    ```\n\n2. Change into the project directory:\n\n    ```bash\n    cd url-shortener\n    ```\n\n3. Install root dependencies:\n\n    ```bash\n    bun install\n    ```\n\n### Running Both Server and Client Together\n\nThe easiest way to run both the server and client simultaneously is using the root-level script:\n\n```bash\nbun run dev\n```\n\nThis uses `concurrently` to run both the server (with live reload) and the client development server in a single terminal with labeled output.\n\nAlternatively, you can run the server and client separately in different terminals as described below.\n\n#### Server Setup\n\n- **Note:** If you are using VS Code, you can use the `Go` extension to install the necessary tools and dependencies.\n\n1. Change into the server directory:\n\n    ```bash\n    cd server\n    ```\n\n2. Create a `.env` file in the server directory:\n\n    ```bash\n    touch .env\n    ```\n\n    Make sure to populate the `.env` file according to the `.env.example` file.\n\n3. Run the server via make:\n\n    - For development, run with live reload:\n\n        ```bash\n        make run/live\n        ```\n\n    - Or build and run the server:\n\n        1. Manually:\n\n            ```bash\n            make build \u0026\u0026 make run\n            ```\n\n        2. Via Docker:\n\n            ```bash\n            docker compose up\n            ```\n\n#### Client Setup\n\n1. Change into the client directory:\n\n    ```bash\n    cd client\n    ```\n\n2. Create a `.env.local` file in the client directory:\n\n    ```bash\n    touch .env.local\n    ```\n\n    Make sure to populate the `.env.local` file according to the `.env.example` file.\n\n3. Install the dependencies:\n\n    ```bash\n    bun install\n    ```\n\n4. Run the development server:\n\n    - For development:\n\n        ```bash\n        bun run dev\n        ```\n\n    - For production:\n\n        ```bash\n        bun run build \u0026\u0026 bun start\n        ```\n\n## Debugging\n\nIf you are using VS Code, you can use the `launch.json` configurations to debug the server and client code.\n\n## Deployment\n\nI am deploying the server to render.com and the client to Vercel. You can deploy the server and client to any platform of your choice.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnitzanpap%2Furl-shortener","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnitzanpap%2Furl-shortener","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnitzanpap%2Furl-shortener/lists"}