/BitLinks-url-Shortner

bitlinks - url shortner , bitlinks is a platform for professionals to make their long URLs short and sweet so that they could be easily remembered

Primary LanguageJavaScriptMIT LicenseMIT

BitLinks - URL Shortener

Welcome to BitLinks, a free and open-source URL shortener. BitLinks allows you to quickly generate short URLs from long ones without needing to sign up or log in. Just paste your full URL, specify your preferred short URL text, and generate!

✨ Features

  • Free: Completely free to use.
  • No Sign-Up Required: Start shortening URLs instantly without the hassle of creating an account.
  • Custom Short URLs: Choose your own preferred short URL text.

🛠 Technology Stack

  • Frontend: Next.js, React.js
  • Styling: Tailwind CSS
  • Notifications: react-hot-toast

🚀 Getting Started

Prerequisites

  • Ensure you have Node.js (version 16 or higher) and npm or yarn installed on your machine.

Steps to Fork and Run This Project

  1. Fork This Repository:

    • Click the "Fork" button at the top right corner of this repository to create a copy under your GitHub account.

  2. Clone the Repository:

    git clone https://github.com/namankoolwal/BitLinks-url-Shortner.git

    Replace your-username with your GitHub username.

  3. Navigate to the Project Directory:

    cd BitLinks-url-Shortner

  4. Install Dependencies: Using npm:

    npm install

    or using yarn:

    yarn install

  5. Set Up Environment Variables:

    • Create a .env.local file in the root directory.
    • Add your environment variables: 
      - NEXT_PUBLIC_BASE_URL= http://localhost:3000
- MONGODB_URI= <YOUR MONGODB URI>

  6. Run the Development Server: Using npm:

    npm run dev

    or using yarn:

    yarn dev

  7. Open your browser and visit: http://localhost:3000

🤝 How to Collaborate

  1. Fork the project.
  2. Clone your forked repository: 
    git clone https://github.com/namankoolwal/BitLinks-url-Shortner.git
  3. Create a Branch for your feature or bug fix: 
    git checkout -b feature-name
  4. Make Your Changes and commit: 
    git add .
git commit -m "Description of your changes"
  5. Push to Your Branch: 
    git push origin feature-name
  6. Submit a Pull Request: Open a pull request to the main branch of this repository and describe your changes.

⭐ Don't Forget to Star This Repository!

If you find this project helpful or inspiring, please give it a ⭐ on GitHub. Your support is much appreciated!

💬 Feedback and Collaboration

Feedback and collaboration are always welcome! If you have suggestions for improvements or want to contribute, feel free to open an issue or submit a pull request. Let's make BitLinks even better together!

📜 License

This project is licensed under the MIT License. See the LICENSE file for more information.

Thank you for checking out BitLinks! Happy shortening!