Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.51 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.51 KB
Raw

iShortener

iShortener is a fast, reliable, and secure URL shortening service designed to make sharing links easier and more efficient.

Use iShortener

iShortener is deployed on Vercel you can use it by going on this URL:

iShortener.vercel.app

Features

  • Quick Shortening: Instantly shorten URLs with just a few clicks.
  • Shareable Links: Easily share shortened links on social media, emails, or messages.
  • Secure Shortening: Ensures the security of your shortened links with advanced encryption techniques.
  • No Registration Required: Start shortening links immediately without the hassle of registration.

About

iShortener is an open-source project created by Arnav Nagpurkar. It is built using Next.js and Tailwind CSS, leveraging the power of modern web technologies to provide a seamless and efficient URL shortening experience.

Development

To run the iShortener project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/arnavnagpurkar/iShortener.git

  2. Navigate to the project directory:

    cd iShortener

  3. Install dependencies:

    npm install
  # or
yarn install

  4. Create a .env.local file in the root directory

  5. Get your Access Token

  6. Your .env.local file should look like this:

    ACCESS_TOKEN = "YOUR_ACCESS_TOKEN_HERE"

  7. Start the development server:

    npm run dev
  # or
yarn dev

  8. Open your browser and visit http://localhost:3000 to access iShortener.

Contributing

Contributions are welcome! If you'd like to contribute to iShortener, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure the code is properly formatted.
  4. Write tests for your changes if applicable.
  5. Commit your changes and push them to your fork.
  6. Submit a pull request detailing the changes you've made.

Issues

If you encounter any issues with iShortener, please report them here.

License

iShortener is open-source software licensed under the MIT License. Check the LICENSE file for more details.

Contact

For any inquiries or questions regarding iShortener, feel free to contact Arnav Nagpurkar at arnavn.dev@gmail.com.