Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 1.85 KB

README.md

File metadata and controls

65 lines (46 loc) · 1.85 KB
Raw

makeme.short
Credits

makeme.short

A Simple and Lightweight URL Shortener Flask App

Built on:

Flask Python 3.7

Other Tools Used:

Running Locally

  • Install Dependencies
  1. Clone the repository
    git clone https://github.com/TheBoringDude/makeme.short.git
  2. Install and activate virtual environment
    virtualenv venv - Windows
    venv\Scripts\activate - Linux / Mac
    source venv/bin/activate
  3. Install Python 3 Requirements
    pip3 install -r requirements.txt
  • Migrating the Database
  1. Edit the config.py and replace the value of SQLALCHEMY_DATABASE_URI with your database.
  2. Migrate
python manage.py init
python manage.py migrate
python manage.py upgrade
  • Starting the Server
    python3 manage.py runserver -d The -d runs in debug mode.

ToDo's:

  • Add Custom Error Pages
  • Add Admin Page
  • Add functionality to the search bar in the Links section
  • Add Social Login Authentications (0Auth)
  • Add autodeletion algo to the QuickLinks
  • Fix future bugs...

Files and Folders:

  • base - Where the tailwindcss import is...
  • makemeshort - Main Flask app
  • manage.py - Manager script of the main app
  • Procfile runtime.txt - Things required by heroku for testing
  • requirements.txt - Required python modules and requirements by the app
  • tailwind.config.js postcss.config.js package.json - Required files for the designing of the frontend (mainly tailwind)
  • *.jpg *.svg - Some static files used in the designing process.

Made By:

❤️ TheBoringDude