Skip to content

wtrbtl03/getPico.Link

Repository files navigation

An elegant, minimum overhead and fully API-based URL Shortner.

Project Stack

Backend

  • Django
  • Whitenoise
  • Nginx
  • Gunicorn

Frontend

  • Tailwind CSS ( That's it :) )

Database

  • MongoDB ( Locally Hosted )

External Services

  • Google OAuth 2.0 : For user sign-in.

API and Design Docs

Full API and design docs can be found here.

API Endpoints

Method URI Description
GET /get/<longURL>/ Shortens the long URL and returns the shortened URL.
GET /load/ Fetches all custom URLs created by the authenticated user.
POST /custompico/<customPhrase>/ Enables an authenticated user to create a custom shortened URL.
PUT /update/<customPhrase>/ Enables an authenticated user to modify a custom short URL they created.
DELETE /delete/<customPhrase>/ Enables an authenticated user to delete a custom short URL they created.

Acknowledgements

Coolicons Line Oval Icons by krystonschwarze under CC Attribution License via SVG Repo.

License

This project is under the GPL v3 License.