Skip to content

chxmbley/minurl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Minurl ๐Ÿ’Ž

A minimal url shortener

Quick Launch ๐Ÿš€

  1. Clone this repo
  2. Run make setup to install dependencies
  3. Run make test to run linters and test suite (optional)
  4. Run make server to build and start the server
  5. 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

About

Minurl ๐Ÿ’Ž // A minimal URL shortener

Resources

Stars

Watchers

Forks