https://github.com/gamemaker1/tau
tiny, adorable, urls
https://github.com/gamemaker1/tau
Last synced: 5 months ago
JSON representation
tiny, adorable, urls
- Host: GitHub
- URL: https://github.com/gamemaker1/tau
- Owner: gamemaker1
- License: agpl-3.0
- Created: 2023-08-30T14:12:46.000Z (almost 3 years ago)
- Default Branch: trunk
- Last Pushed: 2023-09-02T12:21:07.000Z (almost 3 years ago)
- Last Synced: 2025-03-28T19:47:34.680Z (about 1 year ago)
- Language: HTML
- Size: 67.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
#
tiny, adorable, urls
> a url shortener, written in python using [`flask`](https://flask.palletsprojects.com/en/2.3.x/)
> and [`sqlite3`](https://docs.python.org/3/library/sqlite3.html)
## setup
> you'll need [`python3`](https://www.python.org/downloads/) and [`pip`](https://pip.pypa.io/en/stable/installation/) installed beforehand.
download the source code from github - either by [cloning the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository#cloning-a-repository)
or by downloading the source archive directly from [this url](https://github.com/gamemaker1/tau/archives/refs/heads/trunk.zip).
once you have the source downloaded, run `python -m venv .venv` to activate the virtual
environment, followed by a `pip install -r requirements.txt` to install all dependencies.
run `flask --app source/server run` to start a development server.
## deploying
if you wish to deploy this app to production, follow [this guide](https://flask.palletsprojects.com/en/2.3.x/tutorial/deploy/).
## attributions and license
the html templates make use of components from the free and open source library [`hyperui`](https://www.hyperui.dev/).
this code is licensed under the `agpl-3.0` license, a copy of which you can find [here](license.md).