{"id":22743006,"url":"https://github.com/3bbaas/url_shortener","last_synced_at":"2026-02-12T14:34:52.513Z","repository":{"id":267193257,"uuid":"900372431","full_name":"3bbaas/URL_Shortener","owner":"3bbaas","description":"URL-Shortener website","archived":false,"fork":false,"pushed_at":"2024-12-08T23:37:22.000Z","size":842,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-23T23:09:12.878Z","etag":null,"topics":["api","backend","django"],"latest_commit_sha":null,"homepage":"https://3bbas-shorturl.vercel.app","language":"HTML","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/3bbaas.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-08T16:00:46.000Z","updated_at":"2024-12-11T14:32:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"eafa981c-3391-4176-8980-53f2efb224b7","html_url":"https://github.com/3bbaas/URL_Shortener","commit_stats":null,"previous_names":["3bbaas/url_shortener"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FURL_Shortener","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FURL_Shortener/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FURL_Shortener/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3bbaas%2FURL_Shortener/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3bbaas","download_url":"https://codeload.github.com/3bbaas/URL_Shortener/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250528728,"owners_count":21445516,"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":["api","backend","django"],"created_at":"2024-12-11T01:15:31.133Z","updated_at":"2026-02-12T14:34:52.481Z","avatar_url":"https://github.com/3bbaas.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# URL Shortener\n\nA simple Django-based web application that allows users to shorten long URLs using various URL shortening services. This\nproject utilizes the `pyshorteners` library to interact with different URL shortening APIs and provides a user-friendly\ninterface for quick URL shortening.\n\n**Deployment**: [Link](https://3bbas-shorturl.vercel.app)\n\n## Features\n\n- **Multiple URL Shortening Services**: Supports TinyURL, Bitly, Chilp.it, Clck.ru, Cutt.ly, Da.gd, and Is.gd.\n- **URL Validation**: Ensures the provided URL is valid and not already shortened.\n- **Responsive Design**: User-friendly interface adaptable to different screen sizes.\n- **Theme Toggle**: Light and dark mode support with a toggle switch.\n- **Automatic Clipboard Copy**: Click the shortened URL to copy it to your clipboard.\n- **Auto-clear Result**: Shortened URL result disappears after 30 seconds for a cleaner interface.\n\n## Demo\n\n*(Coming Soon!)*\n\n## Screenshots\n\n|                                  Light theme                                  |                                 Dark Theme                                  |\n|:-----------------------------------------------------------------------------:|:---------------------------------------------------------------------------:|\n| \u003cimg src=\"demo/light-theme.png\" title=\"Light theme\" width=\"100%\" crossorigin\u003e | \u003cimg src=\"demo/dark-theme.png\" title=\"Dark Theme\" width=\"100%\" crossorigin\u003e |\n\n## Prerequisites\n\n- Python 3.7 or higher\n- Django 3.2 or higher\n- `pyshorteners` library\n- API keys for Bitly and Cutt.ly (if you intend to use these services)\n\n## Installation\n\n1. **Clone the repository**:\n\n   ```bash\n   git clone https://github.com/yourusername/url_shortener.git\n   cd url_shortener\n   ```\n\n2. **Create a virtual environment**:\n   ```bash\n   python -m venv venv\n   ```\n\n3. **Activate the virtual environment**:\n\n- On Windows:\n  ```bash\n  venv\\Scripts\\activate\n  ```\n- On macOS or Linux:\n  ```bash\n  source venv/bin/activate\n  ```\n\n4. **Install dependencies**:\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n5. **Set up environment variables**:\n\n    - Create a .env file in the root directory.\n    - Add the following variables:\n      ```dotenv\n      SECRET_KEY=your_django_secret_key\n      BITLY_API_KEY=your_bitly_api_key\n      CUTLLY_API_KEY=your_cuttly_api_key\n      ```\n\u003e [!NOTE]  \n\u003e If you don't have API keys for Bitly or Cutt.ly, you can leave them empty or remove related options from the\napplication.\n\n6. **Apply migrations**:\n    ```bash\n    python manage.py migrate\n   ```\n\n7. **Run the development server**:\n    ```bash\n    python manage.py runserver\n   ```\n\n8. **Access the application**:\n\n   Open your web browser and navigate to `http://127.0.0.1:8000/`.\n\n### Usage:\n\n1. **Shorten a URL**:\n\n    - Enter the long URL you wish to shorten in the input field.\n    - Select your preferred URL shortening service from the dropdown menu.\n    - Click on \"Shorten URL\".\n\n2. **Copy Shortened URL**:\n\n    - The shortened URL will be displayed.\n    - Click on the shortened URL to copy it to your clipboard.\n    - A tooltip \"Copied to clipboard!\" will appear upon successful copy.\n\n3. **Theme Toggle**:\n\n    - Use the toggle switch in the navigation bar to switch between light and dark modes.\n    - Your theme preference will be remembered for future visits\n\n### **Project Structure**:\n\n   ```shell\n   url_shortener/\n   ├── manage.py\n   ├── requirements.txt\n   ├── url_shortener/\n   │   ├── __init__.py\n   │   ├── asgi.py\n   │   ├── settings.py\n   │   ├── urls.py\n   │   ├── views.py\n   │   ├── wsgi.py\n   ├── static/\n   │   └── url_shortener/\n   │       ├── fav-icon.ico\n   │       └── logo.png\n   ├── templates/\n   │   └── home.html\n   ```\n\n### **Technologies Used**:\n\n- **Django**: High-level Python web framework.\n- **PyShorteners**: Python library for shortening URLs via various services.\n- **HTML5 \u0026 CSS3**: For structuring and styling the web pages.\n- **JavaScript**: For dynamic interactions on the front-end.\n\n### Contributing\n\nContributions are welcome! If you have suggestions for improvements or would like to report a bug, please open an issue\nor submit a pull request.\n   \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3bbaas%2Furl_shortener","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3bbaas%2Furl_shortener","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3bbaas%2Furl_shortener/lists"}