Aymane11/url-shortener

URL shortener project made using Django.

url-shortener

URL shortener project made using Django
View Demo · Report Bug

---

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Usage
• Contributing
• License
• Acknowledgements

About The Project

This is a URL Shortening website made using Django, where you can customize the slug or let the website create it randomly.

Built With

• Django
• django-bootstrap 4

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You need Python 3 🐍 or later. In Ubuntu, Mint and Debian you can install Python 3 like this:

$ sudo apt-get install python3 python3-pip

For other Linux flavors, macOS and Windows, packages are available here.

You'll also need pipenv, to install it use:

$ pip install pipenv

You can use any virtualenv tool, use the requirements.txt file to install requirements.

Usage

1- Clone the repo :

$ git clone https://github.com/Aymane11/url-shortener.git

2- Install requirements :

$ cd url-shortener
$ pipenv install

3- Run the project :

$ python manage.py runserver

Contributing

1. Fork it 🍴
2. Change it 🔧
3. Open a Pull Request 🔃

Acknowledgements

Thanks to @s0v1x for his help making this project.

License

Distributed under the MIT license. See LICENSE for more information.