README.md

Short-It

A web-app for shortening URLs developed with Python (Flask), MongoDB, HTML, CSS, JavaScript, and BootStrap. The web-app also offers a variety of statistics regarding the shortened URL through a custom dashboard.

To do:

• Draw sequence, architecture, and/or use-case diagrams.
• Code the models for MongoDB in MongoEngine. ✔
• Code the routing logic to interact with the database. ✔
• Design and code the front-end (probably requires AJAX). ✔
• Add logic to integrate dashboard for registered users. ✔

Features

• Responsive UI.
• Shorten URLs to custom or automatically generated strings.
• View analytics for your shortened URL (only for registered users).
• Shorten URLs without registering as a user.
• Share the details of a shortened URL with other users.
• Edit basic account details and your password.

Installation

Follow the steps to run the web-app on your local machine:

1. Clone the repository

   git clone https://github.com/chumba-wamba/Short-It.git

2. Install the Dependencies

   cd Short-It
   pip install -r requirements.txt

3. Install MongoDB on your local machine

4. Run the app on a browser

   cd Short-It
   python run.py

5. Open localhost in your browser @http://localhost:5000

Screenshots

Home Page

Login Page

Register Page

Shorten Page

Dashboard Page

Account Page