chxmbley / minurl

Minurl 💎 // A minimal URL shortener

Minurl 💎

A minimal url shortener

Quick Launch 🚀

0. Clone this repo
1. Run make setup to install dependencies
2. Run make test to run linters and test suite (optional)
3. Run make server to build and start the server
4. Visit Minurl at localhost:3000!

About 🖊️

This project leverages Next.js to build a simple React application using TailwindCSS, SASS, and TypeScript. Data is persisted locally using SQLite with Prisma ORM.

Unit testing is handled with Jest and React Testing Library. E2E tests are automated through Cypress.

Future Work 🔮

• User accounts to manage mini URLs
  • Editable mini urls
  • Expiration dates
  • URL analytics (device, platform, browser, unique visits)
  • Detect website status (e.g. not found, unauthenticated, server error, etc.)
• Public API
  • Rate limits