Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 2.28 KB

README.md

File metadata and controls

80 lines (51 loc) · 2.28 KB
Raw

URL Shortener

URL Shortener is a simple web application built using Flask, Python, and MongoDB. It allows users to create shortened URLs for long links, making them easier to share. The application is deployed and can be accessed at https://url-shortner-x6kn.onrender.com/.

Features

  • Shorten URLs: Create short aliases for long URLs.
  • Redirect: Access the original long URL by using the generated short URL.
  • Statistics: View the number of times a short URL has been accessed.

Usage

  1. Visit https://url-shortner-x6kn.onrender.com/.
  2. Enter the long URL you want to shorten.
  3. Receive the shortened URL.
  4. Share the shortened URL with others.

Deployment

The URL Shortener is deployed and can be accessed at https://url-shortner-x6kn.onrender.com/.

Technology Stack

  • Flask: A lightweight web application framework in Python.
  • MongoDB: A NoSQL database for storing URL mappings.
  • Render: Deployment platform for hosting web applications.

Prerequisites

Before running the application locally, make sure you have the following installed:

Getting Started

  1. Clone the repository:

    git clone https://github.com/sushil-2803/url-shortener.git

  2. Navigate to the project directory:

    cd url-shortener

  3. Install dependencies:

    pip install -r requirements.txt

  4. Configure environment variables:

    • Create a .env file in the root directory.

    • Add the following variables:

      MONGO_URI=your-mongodb-connection-uri

  5. Run the application:

    python app.py

  6. Open your browser and visit http://localhost:5000 to access the URL Shortener.

Contributing

Contributions are welcome! If you'd like to contribute to the project, please follow the guidelines in the CONTRIBUTING.md file.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Enjoy shortening your URLs! 🚀