ShortIt is a web application crafted to simplify the process of URL shortening. With a clean, intuitive interface, ShortIt makes it easy to convert long URLs into short, manageable links. This is particularly useful for sharing links in a more user-friendly manner across different platforms.
This project is built with Django and uses Pipenv for managing dependencies. Follow these steps to get it running on your local machine:
-
Clone the repository to your local machine using
git clone https://github.com/Pokymon/shortit.git. -
Navigate to the project directory with
cd shortit. -
Copy
settings.py.exampletosettings.pyand update the environment variables to match your setup. -
Install Pipenv if you haven't already with
pip install pipenv. -
Install project dependencies with Pipenv by running
pipenv install. -
Enter the Pipenv shell using
pipenv shell. -
Run database migrations with
python manage.py migrate. -
Create an admin user for the Django admin interface using
python manage.py createsuperuser. -
Start the local development server with
python manage.py runserver.
Now you can access the ShortIt web application locally.
We welcome contributions to ShortIt. Feel free to fork the repository or submit a pull request. We appreciate any help, whether it's fixing bugs, improving documentation, or suggesting new features.
ShortIt is distributed under the MIT License. See LICENSE file for more information.
If you have any questions or suggestions, feel free to reach out at [email protected].