Skip to content

Wiper-R/shortcut

Repository files navigation

Shortcut (URL Shortener)

Originally conceived as my college project, Shortcut has evolved over time with occasional refinements. This project aims to overcome the shortcomings found in existing URL shorteners.

Tech Stack

Client: Nextjs, Typescript

Server: Nextjs, Typescript, Prisma, Zod, MongoDB

Features

  • Link shortening with custom backhalf
  • QR Codes
  • Can Edit Links and QR codes
  • User friendly design
  • Minimalistic design
  • Overview (Track your links/QRs)

Demo

https://shortcut-theta.vercel.app/

Known Bugs

  • UI doesn't populate after instant login
  • Some errors are not properly handled
  • Authentication session doesn't persist on browser restart

Future Plans

  • Rework API strucutre
  • Public API (With Documentation)
  • URL Shortenining without Login (Kind of Demo)
  • Track links and engagements effectively

Screenshots

Home Page (I went for minimalistic design) App Screenshot

Login Page App Screenshot

Dashboard App Screenshot

Links Card App Screenshot

Run Locally

Clone the project

  git clone https://github.com/Wiper-R/shortcut

Go to the project directory

  cd shortcut

Rename .env.example to .env and set environment variables

Install pnpm if not already

  npm i pnpm -g

Install dependencies

  pnpm install

Generate Prisma client

  prisma generate

Start the dev server

  pnpm dev

Contributing

Contributions are always welcome!

Authors

License

MIT