https://github.com/gmpsankalpa/url-shortener
This is a simple URL shortener application built with Flask and SQLite.
https://github.com/gmpsankalpa/url-shortener
database html-css-javascript python url-shortener
Last synced: 3 months ago
JSON representation
This is a simple URL shortener application built with Flask and SQLite.
- Host: GitHub
- URL: https://github.com/gmpsankalpa/url-shortener
- Owner: gmpsankalpa
- License: mit
- Created: 2024-03-16T14:56:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-28T08:11:25.000Z (about 1 year ago)
- Last Synced: 2025-01-17T08:32:02.469Z (5 months ago)
- Topics: database, html-css-javascript, python, url-shortener
- Language: Python
- Homepage: https://gmpsankalpa.xyz
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# URL Shortener
This is a simple URL shortener application built with Flask and SQLite. It allows users to input long URLs and generates shortened URLs for easier sharing. The application stores the original and shortened URLs in a SQLite database.
## Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [License](#license)
## Features
- Shorten long URLs to easily shareable shortened URLs.
- Validate input URLs for correctness.
- Display flash messages for user feedback.
- Store URLs in a SQLite database.
- Simple and clean user interface.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- Python 3.x installed on your local machine.
- Basic understanding of Flask web framework.
- Basic understanding of SQLite database.
## Installation
To install and run this application locally, follow these steps:
1. Clone the repository to your local machine:
```bash
git clone https://github.com/gmpsankalpa/url-shortener.git
2. Navigate to the project directory:
```bash
cd url-shortener
3. Install the required Python packages:
```bash
pip install -r requirements.txt
## Usage
1. To run the application locally, use the following command:
```bash
python app.py
2. Once the application is running, open your web browser and go to `http://localhost:5000` to access the URL shortener interface. You can input a long URL in the provided field and click the "Shorten" button to generate a shortened URL.
## Deployment
This application can be deployed to various platforms, including:
- Heroku
- AWS Elastic Beanstalk
- DigitalOcean
- PythonAnywhere
Refer to the deployment documentation of your chosen platform for specific instructions on deploying Flask applications.
## Contributing
Contributions are welcome! Here's how you can contribute to this project:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add new feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Create a new Pull Request.
## License
This project is licensed under the [MIT](LICENSE) License.
---
Repo Details 🤙
Deploy status badge 🤖
[](https://app.netlify.com/sites/gmp-url-shortener/deploys)