{"id":13549823,"url":"https://github.com/muhsin-k/URL-Shortner","last_synced_at":"2025-04-02T23:31:11.825Z","repository":{"id":37492639,"uuid":"126565633","full_name":"muhsin-k/URL-Shortner","owner":"muhsin-k","description":"Creating custom URL shortener using Nodejs","archived":false,"fork":false,"pushed_at":"2023-06-03T07:16:24.000Z","size":1334,"stargazers_count":138,"open_issues_count":14,"forks_count":47,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-22T13:51:23.040Z","etag":null,"topics":["express","material","materialize-css","mongodb","mongoose","nginx","nodejs","react","react-router","rest-api","shortid","url-shortner","valid-url"],"latest_commit_sha":null,"homepage":"","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/muhsin-k.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}},"created_at":"2018-03-24T04:29:35.000Z","updated_at":"2025-03-16T09:28:16.000Z","dependencies_parsed_at":"2024-01-16T18:23:45.182Z","dependency_job_id":null,"html_url":"https://github.com/muhsin-k/URL-Shortner","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhsin-k%2FURL-Shortner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhsin-k%2FURL-Shortner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhsin-k%2FURL-Shortner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhsin-k%2FURL-Shortner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muhsin-k","download_url":"https://codeload.github.com/muhsin-k/URL-Shortner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246910933,"owners_count":20853652,"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":["express","material","materialize-css","mongodb","mongoose","nginx","nodejs","react","react-router","rest-api","shortid","url-shortner","valid-url"],"created_at":"2024-08-01T12:01:25.964Z","updated_at":"2025-04-02T23:31:11.324Z","avatar_url":"https://github.com/muhsin-k.png","language":"JavaScript","readme":"\u003ch1 align=\"center\"\u003e\n  URL-Shortner\n\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eCreating custom URL shortener With Nodejs\u003c/h4\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003csub\u003eBuilt with ❤︎ \u003c/sub\u003e\n\u003c/div\u003e\n\n\u003c/br\u003e\nBuilding a custom URL shortening service like goo.gl using ExpressJs and Mongodb\n\n## Architecture\n\n\u003cimg src=\"sketch/architecture.png\" alt=\"architecture\" /\u003e\n\n## Technologies\n\n- ### Back end\n\n  - [Express](https://expressjs.com/)- Nodejs framwork for building the REST Apis\n  - [Mongodb](http://mongodb.com/)- Document oriented NoSQL database\n  - [Mongoose](https://http://mongoosejs.com)- MongoDB object modeling tool\n  - [Short-id](https://github.com/dylang/shortid)- Short id generator\n  - [Valid-url](https://github.com/ogt/valid-url)- URI validation functions\n  - [Nginx](https://www.nginx.com)- Nginx is event-based and asynchronous web server.\n\n- ### Front end\n\n  - [React](https://reactjs.org/) - JavaScript library for building user interfaces.\n  - [React-router](https://github.com/ReactTraining/react-router)- Complete routing library for React\n  - [Materialize css](http://materializecss.com/)- Responsive front-end framework based on Material Design\n\n## Getting Started\n\n#### Clone the project\n\n```sh\n# clone it\ngit clone https://github.com/muhzi4u/URL-Shortner.git\ncd URL-Shortner\n# Make it your own\nrm -rf .git \u0026\u0026 git init\n```\n\n#### Run back end\n\n```\n# Move to server folder\ncd server/\n# Install dependencies\nyarn install\n\n# Start  server\nyarn run server\n```\n\n#### Run front end\n\n```\n# Move to client folder\ncd client/\n# Install dependencies\nyarn install\n# Start  client\nyarn run start\n```\n\n## Demo\n\n![NSGIF](https://j.gifs.com/1rnQV0.gif)\n\n## Blog\n\n[Creating custom URL shortener with Nodejs](https://codeburst.io/creating-custom-url-shortener-with-nodejs-de10bbbb89c7)\n\n## ☑ TODO\n\n- [x] Front end app\n- [x] Documentation and Blog\n- [x] Add Redis for caching\n- [ ] Change short code algorithm and check duplicate short codes\n\n## License\n\nMIT\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhsin-k%2FURL-Shortner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuhsin-k%2FURL-Shortner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhsin-k%2FURL-Shortner/lists"}