Skip to content

keshavk4/shrinky-web

Repository files navigation

Shrinky URL Shortener

Shrinky is a simple URL shortener service built with Next.js, MongoDB, and Node.js. It allows you to create short and memorable URLs from long and complex ones.

Features

  • Shorten long URLs to create compact and easy-to-share links.
  • Quick and easy setup with MongoDB.

Screenshots

Screenshot 1

Getting Started

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have the following installed:

Installation

  1. Clone the repository:

    git clone https://github.com/keshavk4/shrinky-web.git
  2. Navigate to the project directory:

    cd shrinky-web
  3. Install dependencies:

    npm install
    # or
    yarn install
  4. Set up environment variables:

    Create a .env file in the root directory and provide the following variables:

    MONGODB_URI=your_mongodb_uri

    Replace your_mongodb_uri with your MongoDB connection string.

  5. Start the development server:

    npm run dev
    # or
    yarn dev
  6. Open your web browser and navigate to http://localhost:3000 to access the application.

Usage

  • To shorten a URL, enter the long URL in the input field and click the "Shrink" button.
  • You will receive a shortened URL that you can copy and share.

Visit the Shrinky URL Shortener Website to start using the service.

Built With

  • Next.js - React framework for server-rendered React applications.
  • MongoDB - NoSQL database for storing URL data.
  • Node.js - JavaScript runtime for server-side logic.

License

This project is released under the MIT License. See LICENSE for more details.

About

Shrinky is a simple URL shortener service built with Next.js, MongoDB, and Node.js. It allows you to create short and memorable URLs from long and complex ones.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors