{"id":18952743,"url":"https://github.com/m7moudgadallah/softlink","last_synced_at":"2026-04-04T08:42:32.609Z","repository":{"id":212488204,"uuid":"731615997","full_name":"m7moudGadallah/SoftLink","owner":"m7moudGadallah","description":"is a simple and efficient URL shortener designed to streamline the process of creating and sharing shortened URLs.","archived":false,"fork":false,"pushed_at":"2023-12-14T14:01:18.000Z","size":155,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-01T02:41:45.124Z","etag":null,"topics":["expressjs","functional-testing","integration-testing","jest","mongodb","mongoose","nodejs","postman","rest-api","unit-testing"],"latest_commit_sha":null,"homepage":"https://documenter.getpostman.com/view/27682136/2s9Ykkf2yb","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m7moudGadallah.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-12-14T13:33:25.000Z","updated_at":"2023-12-15T13:30:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"422e24d5-b854-4049-a095-a9d3a1fb68b5","html_url":"https://github.com/m7moudGadallah/SoftLink","commit_stats":null,"previous_names":["m7moudgadallah/softlink"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m7moudGadallah%2FSoftLink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m7moudGadallah%2FSoftLink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m7moudGadallah%2FSoftLink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m7moudGadallah%2FSoftLink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m7moudGadallah","download_url":"https://codeload.github.com/m7moudGadallah/SoftLink/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239952598,"owners_count":19723922,"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","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":["expressjs","functional-testing","integration-testing","jest","mongodb","mongoose","nodejs","postman","rest-api","unit-testing"],"created_at":"2024-11-08T13:34:30.096Z","updated_at":"2025-12-30T20:16:56.263Z","avatar_url":"https://github.com/m7moudGadallah.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SoftLink\n\n## Overview\n\nSoft-Link is a simple and efficient URL shortener designed to streamline the process of creating and sharing shortened URLs. Users can submit their long URLs to the system, receiving a shortened version in return. When others click on the shortened URL, they are seamlessly redirected to the original link.\n\n## Key Features\n\n- **URL Shortening:** Quickly generate concise and shareable links.\n- **Redirection:** Smoothly redirect users to the original URL when clicking on the shortened link.\n\n## Tech Stack\n\n- **Runtime:** Node.js\n- **Language:** JavaScript/TypeScript\n- **Framework:** Express.js\n- **Database:** MongoDB with Mongoose\n- **Testing:** Jest\n- **Documentation and Manual Testing:** Postman\n\n## Getting Started\n\n### Prerequisites\n\n**1. Install Dependencies:**\n\n```bash\nnpm install\n```\n\n**2. Set Environment Variables:**\n\nRename the `.env.example` file to `.env` and fill in the required values.\n\n### Running the Server\n\n**1. Start the Server:**\n\n```bash\nnpm start\n```\n\n**2. Run Tests:**\n\n```bash\nnpm test\n```\n\n## API Documentation\n\nExplore and test the API using **_[Postman](https://documenter.getpostman.com/view/27682136/2s9Ykkf2yb)_**. Refer to the provided Postman collection for details.\n\n### Endpoints\n\n**1. Create a Shortened URL:**\n\n```http\nPOST {{URL}}/api/url/shorten\n```\n\n**2. Redirect to Original URL:**\n\n```http\nGET {{URL}}/api/url/:shortId\n```\n\n## Design\n\nRefer to the `docs` directory for design details:\n\n- [architecture-diagram](./docs/architecture-digram/arch-digram.png) for the project's architecture diagram.\n- [erd](./docs/erd/erd.png) for the simple Entity-Relationship Diagram.\n\n## License\n\nThis project is licensed under the [MIT License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm7moudgadallah%2Fsoftlink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm7moudgadallah%2Fsoftlink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm7moudgadallah%2Fsoftlink/lists"}