Skip to content

murillo2030/FlaskLinkShortener

Repository files navigation

Project logo

Flask Link Shortener


Website link shortener

📝 Table of Contents

🧐 About

Just a small project for casual use.

🏁 Getting Started

$ git clone https://github.com/MurilloMB/FlaskLinkShortener.git

Prerequisites

  1. Python 3.13 or newer
  2. Git

Installing

All you need is inside the requirements.txt file.

Just clone the repository, create a virtual envinronment in python with

$ python -m venv venv

After that get into the virtual envinronment according your operational system


Windows

$ .\venv\Scripts\activate.bat

Need execution policy set to unrestricted to work

Linux

$ source ./venv/bin/activate

And at final

$ pip install -r requirements.txt

🎈 Usage

First step is get in to your virtual envinroment, if you don't know how go to - Getting Started

Second step is set the local variable (SECRET_KEY) for database encryption purposes

Windows

$ $env:SECRET_KEY = "<YOUR_SECRET_KEY>"

Linux

$ set SECRET_KEY=<YOUR_SECRET_KEY>

The SECRET_KEY need to be a 32 url-safe base64 bytes, like that mZ1Wv0TRoG5pL7klT9oYbVv9XBbkIPhPTfBQsyvVr0k=

Use that command for initialize the database

$ flask initdb

Use the correctly startup for your operational system

Windows

$ .\run.bat

Linux

$ ./run

⛏️ Built Using

✍️ Authors

Aditional

  • @thomascsd Thanks for VSCode Readme Pattern Extension

About

Small project for casual use

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published