{"id":23223811,"url":"https://github.com/guilhermecaz/shurl_django","last_synced_at":"2026-04-13T06:46:16.415Z","repository":{"id":243135362,"uuid":"811573261","full_name":"GuilhermeCAz/shurl_django","owner":"GuilhermeCAz","description":"Shurl is a URL shortening application built with Django. It allows users to create short URLs for their long URLs.","archived":false,"fork":false,"pushed_at":"2024-06-28T22:26:59.000Z","size":66,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-11T13:39:00.601Z","etag":null,"topics":["django","docker","docker-compose","postgresql","python","url-shortener"],"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/GuilhermeCAz.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":"2024-06-06T21:33:32.000Z","updated_at":"2024-12-17T23:54:03.000Z","dependencies_parsed_at":"2024-06-06T22:58:03.110Z","dependency_job_id":"9fe4f18c-f630-4fe7-9b91-2fa24b41a39f","html_url":"https://github.com/GuilhermeCAz/shurl_django","commit_stats":null,"previous_names":["guilhermecaz/shurl_django"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuilhermeCAz%2Fshurl_django","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuilhermeCAz%2Fshurl_django/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuilhermeCAz%2Fshurl_django/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuilhermeCAz%2Fshurl_django/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GuilhermeCAz","download_url":"https://codeload.github.com/GuilhermeCAz/shurl_django/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247368518,"owners_count":20927898,"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","docker","docker-compose","postgresql","python","url-shortener"],"created_at":"2024-12-18T23:19:27.638Z","updated_at":"2025-10-31T05:43:39.301Z","avatar_url":"https://github.com/GuilhermeCAz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shurl\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Django CI](https://github.com/GuilhermeCAz/shurl_django/actions/workflows/django.yaml/badge.svg)](https://github.com/GuilhermeCAz/shurl_django/actions/workflows/django.yaml)\n[![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FGuilhermeCAz%2Fshurl_django%2Fmain%2Fpyproject.toml\u0026logo=python\u0026label=Python)](https://www.python.org/downloads/)\n[![Django](https://img.shields.io/badge/Django-%23092E20?logo=django)](https://www.djangoproject.com/)\n[![Docker](https://img.shields.io/badge/Docker-%232496ED?logo=docker\u0026logoColor=white)](https://www.docker.com/)\n[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-%234169E1?logo=postgresql\u0026logoColor=white)](https://www.postgresql.org/)\n[![Make](https://img.shields.io/badge/Make-%236D00CC?logo=make)](https://www.gnu.org/software/make/)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)\n[![OpenAPI](https://img.shields.io/badge/OpenAPI-%2385EA2D?logo=swagger\u0026logoColor=white\u0026color=null)](https://swagger.io/specification/)\n[![Github Actions](https://img.shields.io/badge/GitHub%20Actions-%232088FF?logo=githubactions\u0026logoColor=white)](https://github.com/features/actions)\n\nShurl is a URL shortening application built with Django. It allows users to create short URLs for their long URLs.\n\n## Features\n\n- Shorten long URLs\n- Redirect to the original URL using the shortened URL\n- User authentication and registration // _TODO_\n- URL statistics // _TODO_\n\n## Project Setup\n\nClone this repository:\n\n```sh\ngit clone https://github.com/GuilhermeCAz/shurl_django.git\ncd shurl_django\n```\n\nCreate a .env file according to .env.example.\n\nTo build the Docker images and start the project in detached mode, use the following command:\n\n```sh\ndocker compose up --build --detach\n```\n\nUsing Make:\n\n```sh\nmake up\n```\n\nMake Migrations\n\n```sh\ndocker compose run web python manage.py makemigrations\ndocker compose run web python manage.py migrate\n```\n\nUsing Make:\n\n```sh\nmake migrate\n```\n\n**Optional**: To create a superuser for the Django admin, run:\n\n```sh\ndocker compose run web python manage.py createsuperuser --noinput\n```\n\nUsing Make:\n\n```sh\nmake superuser\n```\n\nYou'll need to set the necessary environment variables for the superuser credentials beforehand.\n\n## Usage\n\n1. Visit the Shurl homepage: `http://localhost:8000`\n2. Paste a long URL into the input field and click \"Shorten\".\n3. Copy the shortened URL and use it to share with others.\n4. Click the shortened URL to be redirected to the original URL.\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.\n\n## Installation (for development only)\n\nCreate .venv\n\n```shell\npython -m venv .venv\n```\n\nActivate the virtual environment\n\n```shell\n.venv/scripts/activate\n```\n\nInstall dependencies\n\n```shell\npython -m pip install --upgrade pip\npip install -r requirements-dev.txt\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguilhermecaz%2Fshurl_django","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguilhermecaz%2Fshurl_django","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguilhermecaz%2Fshurl_django/lists"}