This project is a URL shortener application built with FastAPI. It allows users to shorten long URLs, and manage them through a set of administrative endpoints, and forward to the original URLs.

Follow these steps to set up your environment:

To get started, clone this repository to your local machine:

git clone https://github.com/erfanghorbanee/url_shortener.git
cd url_shortener

Run the following command to install the necessary dependencies:

pip install -m requirements.txt

We use environment variables to manage configuration and secrets. You'll find a file in the repository named .env_sample. This file contains all the required environment variables with placeholder values.

Here’s how to set up your .env file:

• Copy the .env_sample file and rename it to .env:

  cp .env_sample .env

• Open the .env file and replace all placeholder values with your actual data. For example:

  ENV_NAME="YOUR_ENV_NAME"
  BASE_URL="https://127.0.0.1:8000"
  DB_URL="sqlite:https:///./shortener.db"
  

Once you have configured your environment variables, you can start the application by running:

uvicorn shortener_app.main:app --reload

Your application should now be running on https://localhost:8000.

If you have suggestions or issues, please open an issue through GitHub. All contributions are welcomed.

• Custom URL key: Let your users create custom URL keys instead of a random string.
• Peek URL: Create an endpoint for your users to check which target URL is behind a shortened URL.
• Graceful Forward: Check if the website exists before forwarding.

This project was inspired by and built upon the tutorial from Real Python. For more details, you can check out the original tutorial here.