Giter Club home page Giter Club logo

makeme.short's Introduction

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

makeme.short's People

Contributors

dependabot[bot] avatar renovate-bot avatar tbdsux avatar

Watchers

 avatar

makeme.short's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.