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.
- Shorten long URLs to create compact and easy-to-share links.
- Quick and easy setup with MongoDB.
These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.
Before you begin, ensure you have the following installed:
-
Clone the repository:
git clone https://github.com/keshavk4/shrinky-web.git
-
Navigate to the project directory:
cd shrinky-web -
Install dependencies:
npm install # or yarn install -
Set up environment variables:
Create a
.envfile in the root directory and provide the following variables:MONGODB_URI=your_mongodb_uri
Replace
your_mongodb_uriwith your MongoDB connection string. -
Start the development server:
npm run dev # or yarn dev -
Open your web browser and navigate to
http://localhost:3000to access the application.
- 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.
- Next.js - React framework for server-rendered React applications.
- MongoDB - NoSQL database for storing URL data.
- Node.js - JavaScript runtime for server-side logic.
This project is released under the MIT License. See LICENSE for more details.
