https://github.com/aarush-narang/url-shortener

https://github.com/aarush-narang/url-shortener

css django flask html javascript mongodb python vercel

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/aarush-narang/url-shortener
• Owner: aarush-narang
• License: gpl-3.0
• Created: 2021-09-17T22:51:41.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-12T05:58:47.000Z (8 months ago)
• Last Synced: 2024-03-12T06:46:41.713Z (8 months ago)
• Topics: css, django, flask, html, javascript, mongodb, python, vercel
• Language: JavaScript
• Homepage: https://urls.aarushnarang.com
• Size: 364 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# URL Shortener

Created using Flask and VanillaJS, this is a URL shortener in which you can also create an account to save your shortened URLs.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install the following dependencies

- flask

- flask_wtf

- pymongo

Additionally, create a mongoDB database for the URLs and create a .env file in the root directory with the following variables:

- MONGO_DB_URI

    - copy the connection URI from your mongoDB database.

- DOMAIN

    - your local IP address.

- PORT

    - the port you want to use.

- FLASK_SECRET_KEY

    - the secret key for your flask application.

- PEPPER

    - the pepper string for storing account passwords.

Then, change your directory to the `/URL-Shortener/src` directory. To start, type

```bash

python app.py

```

And you're finished!

## How to Use

To shorten a URL, type in the main textbox and press the `Shorten` button or click hit `Enter`. The shortened URL will be displayed in the same textbox.

![Main Textbox Location](./assets/shorten_url_location.png)

To sign in or sign up, press the `Sign In` or `Sign Up` button.