Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.47 KB

README.md

File metadata and controls

36 lines (22 loc) · 1.47 KB

GHUS 🔥

Make short urls with github issues. Learn more.

GSHU

🧪 Try it out

🚀 How to use

Paste a link into the input field and click on the button. You will get a short url. You can use it to redirect to the original link.

Because we are using my instance, wich is hosted on github pages, the link will be like this:

https://rooyca.github.io/short/9

If you want to use your own instance, you can fork this repo and follow the instructions.

You can also run your own instance of this app. For that, you'll need:

  1. Create a github access token with the public_repo scope. Learn more.
  2. Rename the .env.example file to .env and paste your token there. If you are using your own instance, you can also change the GITHUB_REPOSITORY_OWNER, GITHUB_REPOSITORY_NAME, URL_SHORTENER variables.
  3. Run the app. (I recommend using a virtual enviroment. Learn more.)
pip install -r requirements.txt
python -m uvicorn github.main:app --reload

📝 License

MIT