Skip to content

Vignesh6236/Shortify

Repository files navigation

Shortify 🔗

Shortify is a modern URL shortener built to create and manage shortened links easily and efficiently. Developed using React, Next.js, MongoDB, and Tailwind CSS, it offers a fast and secure experience.

Table of Contents

Project Description 📋

Shortify is designed for individuals looking to simplify their URLs. With a clean and simple interface, Shortify makes managing links seamless and intuitive.

Features 🌟

  • URL Shortening: Quickly create shortened links for any URL.
  • Custom Aliases: Create branded links with custom aliases.
  • Secure Storage: All data is securely stored in MongoDB.
  • Modern UI/UX: Built with Tailwind CSS for a clean and accessible interface.

Tech Stack 🛠️

  • React: For building dynamic user interfaces.
  • Next.js: For server-side rendering and API integration.
  • MongoDB: For secure and scalable data storage.
  • Tailwind CSS: For styling and design.

Prerequisites 📦

Before you begin, ensure you have the following installed:

  • Node.js: For running the development server.
  • Git: For version control and cloning the repository.
  • MongoDB: For local or cloud database setup.

Installation and Usage 🚀

  1. Clone the repository:

    git clone https://github.com/Vignesh6236/Shortify.git
  2. Navigate to the project directory:

    cd shortify
  3. Install dependencies:

    npm install
  4. Set up environment variables:

    Create a .env.local file in the root directory and add the following:

    MONGODB_URI=mongodb://localhost:27017
    NEXT_PUBLIC_HOST=http://localhost:3000
  5. Start the development server:

    npm run dev
  6. Access the application:

    Open your browser and navigate to http://localhost:3000.

Screenshots 📷

Desktop-

Home Page

Screenshot 2025-01-07 124015

Generate Page

Screenshot 2025-01-07 124033

Mobile-

Home Page

Screenshot_2025-01-07-12-42-39-57_40deb401b9ffe8e1df2f1cc5ba480b12

Generate Page

Screenshot_2025-01-07-12-42-47-54_40deb401b9ffe8e1df2f1cc5ba480b12

Deployment 🚀

Shortify is deployed using Vercel for seamless hosting and quick deployment. You can access the live site here:
https://vignesh-shortify.vercel.app/

Contributing 🤝

Contributions are welcome! If you have any ideas or improvements, feel free to submit a Pull Request.

Acknowledgments 🙏

  • React: For the front-end framework.
  • Next.js: For server-side rendering and API capabilities.
  • MongoDB: For the database infrastructure.
  • Tailwind CSS: For styling and utility classes.
  • MDN Web Docs: For comprehensive web development documentation.
  • Vercel: For providing seamless deployment and hosting solutions.

About

Shortify is a simple tool to transformlung URLs into short, shareable links

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors