Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 3.4 KB

README.md

File metadata and controls

62 lines (47 loc) · 3.4 KB
Raw

URL SHORTNER


SHORTNER , SIMPLIFY , SHARE : STREAMLINE YOUR LINKS WITH OUR URL SHORTNER
Welcome to our URL Shortener! This open-source tool allows you to shorten long web addresses into concise, easy-to-share links. Say goodbye to lengthy URLs and optimize your online sharing experience.

Features

  • Generate short and memorable URLs for any web address.
  • Lightning fast broken link checker
  • Minimal UI and database setup that make this process even faster

Technologies Used

  • Front-end Framework: React
  • Backend: Next.js
  • Backend Database: Supabase
  • ORM: Prisma

Demo / Screen Shots

Checkout our URL SHORTENER and feel free to share your views

How To Use

You can also run our code in your device by following the steps given below

  1. Clone the repository : git clone https://github.com/bitspaceorg/url-shortner
  2. Install all dependencies:
    • npm i : This will install the required packages
  3. Set up the database:
    • Create a Supabase project and obtain the connection string.
    • Create the .env file with your Supabase connection string stored in DATABASE_URL variable
      For Example , sh DATABASE_URL = "postgresql://postgres:[YOUR PASSWORD]@db.[YOUR DATABASE ID].supabase.co:5432/postgres"
    • Run npx prisma migrate dev --name init followed by npx prisma generate to connect the database with your project
  4. After all the above steps are done successfully, run npm run dev

Now go to the respective port of localhost to experience our URL shortener running in your device

Contributing

We highly appreciate contributions from the open-source community, as they play a crucial role in improving and advancing the project. Whether you're a developer, designer, tester, or documentation enthusiast, your contributions are valuable to us. Join us in making a difference!

Contributors