Skip to content

sandypockets/shorter

Repository files navigation

Shorter

Shorter is a super simple URL shortener. Shorter is currently live at shorter.one, and you can create as many URLs as you'd like for free. However since it was built just for fun, the URLs might stop working at some point in the future. Until then, please enjoy it.

🛠 Built with

  • Next.js
  • React
  • Tailwind CSS
  • Storybook

✨ Features

  • Login with magic link
  • Create, modify, and delete short URLs
  • Click to copy short URL to clipboard

🧭 Roadmap

See the open issues for a list of proposed features (and known issues).

🚀 Getting started

To run Shorter locally, you will need a Supabase account.

  1. Fork and clone this project
  2. Install dependencies
yarn install
  1. Create a new .env.local file
  2. Copy the contents of .env.local.example into the new .env.local file
  3. Replace the placeholders in the .env.local file with your real Supabase credentials
  4. Start the development server
yarn dev
  1. Navigate to localhost:3000 in your browser

📦 Dependencies

  • Next 11.01
  • React 17.0.2
  • React-DOM 17.0.2
  • supabase/supabase-js 1.21.0
  • axios 0.21.1
  • @headlessui/react 1.4.0
  • @heroicons/react 1.0.3
  • @supabase/supabase-js 1.21.0
  • @tailwindcss/forms 0.3.3
  • @tailwindcss/typography 0.4.1

Dev dependencies

  • storybook/addon-essentials 6.3.0
  • storybook/addon-links 6.3.0
  • storybook/react 6.3.0
  • autoprefixer 9.8.6
  • babel-loader 8.0.5
  • postcss 7.0.36
  • serve 11.3.2
  • tailwindcss tailwindcss/postcss7-compat@^2.2.4

🛠 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📸 Screenshots

shorter homepage

shorter your urls list

create new short url

shorter features list

shorter pricing page

Helpful links