{"id":15444503,"url":"https://github.com/mhmdkanj/slash-idk","last_synced_at":"2026-01-08T04:05:49.324Z","repository":{"id":43348572,"uuid":"464276169","full_name":"mhmdkanj/slash-idk","owner":"mhmdkanj","description":"URL shortener local web app","archived":false,"fork":false,"pushed_at":"2022-03-07T22:53:47.000Z","size":38,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T08:43:21.128Z","etag":null,"topics":["django","python3","url","url-shortener","webapp"],"latest_commit_sha":null,"homepage":"","language":"Python","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/mhmdkanj.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}},"created_at":"2022-02-27T23:08:09.000Z","updated_at":"2022-12-19T01:02:45.000Z","dependencies_parsed_at":"2022-08-19T23:50:46.042Z","dependency_job_id":null,"html_url":"https://github.com/mhmdkanj/slash-idk","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/mhmdkanj%2Fslash-idk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhmdkanj%2Fslash-idk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhmdkanj%2Fslash-idk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhmdkanj%2Fslash-idk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mhmdkanj","download_url":"https://codeload.github.com/mhmdkanj/slash-idk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245991585,"owners_count":20706129,"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":["django","python3","url","url-shortener","webapp"],"created_at":"2024-10-01T19:41:28.791Z","updated_at":"2026-01-08T04:05:49.262Z","avatar_url":"https://github.com/mhmdkanj.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# slash/idk\n\n`slash/idk` *(Slash, I don't know)* is a [Django](https://www.djangoproject.com/)-based web app that lets you run a simple local web server, where you can shorten long URLs with the name of your choice.\n\nBy providing the desired name as a subdirectory to the server's domain name, the app redirects you to the original page mapped to this name.\n\n## Requirements\n\nTo run the web app, you primarily need the following installed on your system:\n- [Python 3.7+](https://www.python.org/)\n\n## Install\n\nTo install the web app, clone the repository in the directory of your choice and enter the project's root directory:\n\n```sh\ngit clone https://github.com/mhmdkanj/slash-idk.git\ncd slash-idk\n```\n\nIt is highly recommended to deal with the app within a virtual environment.\nFor more info regarding virtual environments, please refer to the [Python docs](https://docs.python.org/3/tutorial/venv.html).\nTo create one, execute the following:\n\n```sh\npython3 -m venv ./venv\nsource ./venv/bin/activate  # for Unix/MacOS systems\n# OR\nvenv\\Scripts\\activate.bat  # for Windows systems\n```\n\nNow, you can safely install the dependencies of the web app using [pip](https://pypi.org/project/pip/):\n\n```sh\npip install -r requirements.txt\n```\n\nJust for the first time, it is required to set up the database used by the web app (or at least make sure it's okay) by just running the following Django commands:\n\n```sh\npython src/manage.py makemigrations\npython src/manage.py migrate\n```\n\n## Usage\n\nTo run the server, use the following Django command:\n\n```sh\npython src/manage.py runserver\n```\n\nMost probably, the web server will use port `8000` (otherwise, check the output of the previous command).\nIf that's the case, then you can open the app by inputting the following URL in your web browser: [http://localhost:8000/](http://localhost:8000/)\n\n### Shortening a URL\n\nTo add a mapping:\n1. Paste your URL in the first field\n2. Enter a short name in the second field\n3. Just click `Save`!\n\nFor instance, if typing out `http://google.com` tires you, and you would rather use something short like `ggl`, you can input this info as such and then click save:\n\n![Usage](img/usage.png)\n\nThe next time you want to visit this site, you can then enter in your browser:\n`http://localhost:8000/ggl`, which redirects you to `http://google.com`.\n\nYou can also click on `\"Suggest Name\"` to suggest a randomly generated shortened name for the URL.\n\n### Displaying Saved URLs\n\nClick on `\"My URLs\"` on the navigation bar to list all saved shortened URLs.\n\nYou can also choose to delete any of them by clicking on the button next to the desired entry.\n\n![My URLs](img/my_urls.png)\n\n### Quitting the Server\n\nTo quit the server, press `Ctrl`+`C` within the terminal the server was launched from.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmhmdkanj%2Fslash-idk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmhmdkanj%2Fslash-idk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmhmdkanj%2Fslash-idk/lists"}