Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 1.75 KB

README.md

File metadata and controls

80 lines (55 loc) · 1.75 KB
Raw

🔗 A Laravel URL Shortener Platform

My first project using Laravel and Tailwind!

✨ Key Features

  • Login/Register
  • Create short links 4-64 characters long
  • Send e-mail to link owner once the link visited
  • Track the visit count of a link
  • Contact form
  • API for listing, creating, updating and destroying links
  • Admin Panel

API Usage

Authorization: Bearer Token (The token you got from setup below)

Gain access token for API usage

  GET /api/user/get_token
Parameter Type Description
username string Your username in site
password string Your password in site

List all short links

  GET /api/user/links

List the short link of given id

  GET /api/user/links/{id}

Create short link

  POST /api/user/links
Parameter Type Description
main_url url Desired url
length integer Length of short link (4-64 long)
send_email boolean Send e-mail once link visited?

Update short link

  PUT /api/user/links/{id}
Parameter Type Description
main_url url Optional if send_email exists
send_email boolean Optional if main_url exists

Delete short link

  DELETE /api/user/links/{id}

📝 Todo List

  • Beautify the front-end
  • Create QR-Code for short link
  • Protect short links with password

📸 Screenshots

![Screenshot 1](some screen shot)