Table of Contents

1. About The Project
2. Getting Started
3. Contributing
4. Contact

About The Project

This is a URL Shortener application.

A URL shortener is a service that converts a provided long URL - https://some.domain.com/some-path-to/somewhere - into a shorter one like https://w.xyz/abcdef.

Built with Python, Django, with AJAX. This application was designed such that there is both a web-browser-accessible frontend web application, and a backend service which the frontend connects to via a HTTP-based API.

As this project is purely MVP-scoped, I have not deployed it online. However, feel free to clone this project and run it locally on your computer.

Getting Started

To get started using the application, you can either simply head over to

Alternatively, if you would like to run this locally, you may download the .zip file, open the terminal, navigate to the 'url_shortener' directory, and run python manage.py runserver in your terminal.

Note: As this file runs on PORT 8000, make sure that it is not already in use. To check and kill processes running on the port:

For Linux/Mac OS search (sudo) run this in the terminal:

$ lsof -i tcp:8000
$ kill -9 PID

On Windows:

netstat -ano | findstr :8000
tskill typeyourPIDhere

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Dorian Fong - My Website | My Email | My LinkedIn

(back to top)