Giter Club home page Giter Club logo

tiny0's Introduction

How it works

Each URL that is submitted goes through a simple check for validity and/or added http:// before it to redirect successful. After that, a base 64 string is generated and added to a SQLite database with the corresponding URL that was submitted. The user is then given a short URL that is formatted as: WEBSITE_DOMAIN/token, the token being the base 64 string. Whenever this URL is visited the user will get redirected to the tokens corresponding URL in the database.

Run locally

Highly encouraged to create a python environment first.

Clone the repository:

$ git clone https://github.com/xemeds/tiny0.git

Move into the cloned folder and install the required libraries:

$ cd tiny0
$ pip install -r requirements.txt

After that run with:

$ python run.py

Visit the below URL to view the flask app:

127.0.0.1:5000

NOTE: When running locally all redirects will also be local.

Deploying

If you do not have a dedicated server, I highly recommend using Linode, Heroku or PythonAnywhere to host your application.

Before deploying, make sure to set the following environment variables:

$ export WEBSITE_DOMAIN=
$ export SECRET_KEY=
$ export DEBUG=
$ export SQLALCHEMY_DATABASE_URI=

If not they will default to the following values:

WEBSITE_DOMAIN=127.0.0.1:5000
SECRET_KEY=SECRET_KEY
DEBUG=true
SQLALCHEMY_DATABASE_URI=sqlite:///database.db

License

This project is under the MIT license.

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.