https://github.com/vignesh6236/shortify
Shortify is a simple tool to transformlung URLs into short, shareable links
https://github.com/vignesh6236/shortify
mongodb mongodb-atlas nextjs postman-api reactjs tailwindcss
Last synced: 3 months ago
JSON representation
Shortify is a simple tool to transformlung URLs into short, shareable links
- Host: GitHub
- URL: https://github.com/vignesh6236/shortify
- Owner: Vignesh6236
- Created: 2024-12-21T06:26:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-07T07:30:38.000Z (over 1 year ago)
- Last Synced: 2025-02-13T00:41:20.611Z (over 1 year ago)
- Topics: mongodb, mongodb-atlas, nextjs, postman-api, reactjs, tailwindcss
- Language: JavaScript
- Homepage: https://vignesh-shortify.vercel.app/
- Size: 520 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](#project-description-)
- [Features](#features-)
- [Tech Stack](#tech-stack-️)
- [Prerequisites](#prerequisites-)
- [Installation and Usage](#installation-and-usage-)
- [Screenshots](#screenshots-)
- [Deployment](#deployment-)
- [Contributing](#contributing-)
- [Acknowledgments](#acknowledgments-)
## 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](https://reactjs.org/):** For building dynamic user interfaces.
- **[Next.js](https://nextjs.org/):** For server-side rendering and API integration.
- **[MongoDB](https://www.mongodb.com/):** For secure and scalable data storage.
- **[Tailwind CSS](https://tailwindcss.com/):** For styling and design.
## Prerequisites 📦
Before you begin, ensure you have the following installed:
- **[Node.js](https://nodejs.org/):** For running the development server.
- **[Git](https://git-scm.com/):** For version control and cloning the repository.
- **[MongoDB](https://www.mongodb.com/):** For local or cloud database setup.
## Installation and Usage 🚀
1. **Clone the repository:**
```bash
git clone https://github.com/Vignesh6236/Shortify.git
```
2. **Navigate to the project directory:**
```bash
cd shortify
```
3. **Install dependencies:**
```bash
npm install
```
4. **Set up environment variables:**
Create a `.env.local` file in the root directory and add the following:
```env
MONGODB_URI=mongodb://localhost:27017
NEXT_PUBLIC_HOST=http://localhost:3000
```
5. **Start the development server:**
```bash
npm run dev
```
6. **Access the application:**
Open your browser and navigate to `http://localhost:3000`.
## Screenshots 📷
### Desktop-
### Home Page
### Generate Page
### Mobile-
### Home Page
### Generate Page
## Deployment 🚀
Shortify is deployed using **[Vercel](https://vercel.com/)** for seamless hosting and quick deployment. You can access the live site here:
**[https://vignesh-shortify.vercel.app/](https://vignesh-shortify.vercel.app/)**
## Contributing 🤝
Contributions are welcome! If you have any ideas or improvements, feel free to submit a [Pull Request](https://github.com/Vignesh6236/Shortify/pulls).
## Acknowledgments 🙏
- **[React](https://reactjs.org/):** For the front-end framework.
- **[Next.js](https://nextjs.org/):** For server-side rendering and API capabilities.
- **[MongoDB](https://www.mongodb.com/):** For the database infrastructure.
- **[Tailwind CSS](https://tailwindcss.com/):** For styling and utility classes.
- **[MDN Web Docs](https://developer.mozilla.org/en-US/):** For comprehensive web development documentation.
- **[Vercel](https://vercel.com/):** For providing seamless deployment and hosting solutions.