https://github.com/iiiiii1wepfj/fastapi-tortoise-orm-url-shortener
a url shortener with fastapi and tortoise-orm
https://github.com/iiiiii1wepfj/fastapi-tortoise-orm-url-shortener
api asyncio database db fastapi link-shortener linkshortener mysql orm postgres postgresql python python3 sql sqlite starlette tortoise-orm url-shortener urlshortener uvicorn
Last synced: 3 months ago
JSON representation
a url shortener with fastapi and tortoise-orm
- Host: GitHub
- URL: https://github.com/iiiiii1wepfj/fastapi-tortoise-orm-url-shortener
- Owner: iiiiii1wepfj
- License: gpl-3.0
- Created: 2021-06-27T13:17:05.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-24T08:05:20.000Z (almost 2 years ago)
- Last Synced: 2024-07-25T08:19:18.303Z (almost 2 years ago)
- Topics: api, asyncio, database, db, fastapi, link-shortener, linkshortener, mysql, orm, postgres, postgresql, python, python3, sql, sqlite, starlette, tortoise-orm, url-shortener, urlshortener, uvicorn
- Language: Python
- Homepage:
- Size: 129 KB
- Stars: 21
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fastapi-tortoise-orm-url-shortener
a url shortener with fastapi and tortoise-orm
# how to run
1. git clone https://github.com/iiiiii1wepfj/fastapi-tortoise-orm-url-shortener.git
2. cd fastapi-tortoise-orm-url-shortener
3. pip3 install -U -r requirements.txt
4. cp config.py.example config.py (you can also change the database url and the port of the url shortener)
5. python3 main.py
# docs
after running the main.py file, in the endpoint /docs
# todo
* make option to register/login for some options like edit my links, delete my links and more
* make a better frontend
if you have more ideas or if you want to add something from the todo-list you can fork the repository and create a pull request (make sure the code is working and using black code format)
# contact me
you can open here issue or:
* telegram - https://t.me/itayki
* mail - itay@itayki.com