https://github.com/mohammadhashim135/let-me-cut
LetMeCut is a Next.js-based URL shortener that allows users to shorten URLs and manage their links effortlessly. It integrates MongoDB for data storage, enabling persistent storage of all shortened URLs. The app supports both dark and light modes, and it provides real-time feedback with Toastify notifications.
https://github.com/mohammadhashim135/let-me-cut
dbms good-first-issue js mondodb nextjs project react reactjs typescript ui url url-shortener
Last synced: 3 months ago
JSON representation
LetMeCut is a Next.js-based URL shortener that allows users to shorten URLs and manage their links effortlessly. It integrates MongoDB for data storage, enabling persistent storage of all shortened URLs. The app supports both dark and light modes, and it provides real-time feedback with Toastify notifications.
- Host: GitHub
- URL: https://github.com/mohammadhashim135/let-me-cut
- Owner: mohammadhashim135
- License: mit
- Created: 2025-02-23T09:59:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-17T19:04:13.000Z (about 1 year ago)
- Last Synced: 2025-07-09T11:08:41.797Z (12 months ago)
- Topics: dbms, good-first-issue, js, mondodb, nextjs, project, react, reactjs, typescript, ui, url, url-shortener
- Language: TypeScript
- Homepage:
- Size: 2.82 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **LetMeCut** 🌐
**A Secure, Interactive, and Responsive URL Shortener**
## **Overview**
LetMeCut is a **Next.js-based** URL shortener that allows users to shorten URLs and manage their links effortlessly. It integrates **MongoDB** for data storage, enabling persistent storage of all shortened URLs. The app supports both dark and light modes, and it provides real-time feedback with Toastify notifications. The design is fully responsive, ensuring a seamless experience across all devices.
---
## **Features** 🚀
✅ **Shorten URLs** – Easily shorten long URLs for quick sharing.
✅ **Dark & Light Mode** – Switch between dark and light themes for better accessibility.
✅ **Interactive UI** – A modern, responsive design with real-time updates and feedback.
✅ **Link Management** – View and manage all your shortened links.
✅ **MongoDB Integration** – Persistent storage of all shortened URLs in MongoDB.
✅ **Toast Notifications** – Get real-time feedback for actions (success, errors, and warnings) using Toastify.
✅ **Responsive Design** – Optimized for mobile and desktop devices.
---
## **Tech Stack** 🛠
- **Frontend:** Next.js, React.js, Tailwind CSS
- **State Management:** React Hooks (`useState`, `useEffect`)
- **Backend:** Next.js API routes for backend functionality
- **Database:** MongoDB (for persistent storage of shortened URLs)
- **UI Components:** Font Awesome icons, Toastify notifications, TailwindCSS for responsive design
- **Other:** next.config.js for configuration, dotenv for environment variables
---
## **Installation & Setup** 🏗
### **1. Clone the Repository**
```bash
git clone https://github.com/mohammadhashim135/let-me-cut.git
cd let-me-cut
```
### **2. Install Dependencies**
```bash
npm install
```
### **3. Create .env.local**
```bash
MONGODB_URI=mongodb://localhost:27017/
```
### **4. Start the Application**
```bash
npm run dev
```
---
## **Usage Guide** 📝
🔹 **Enter URL** – Paste the URL you want to shorten in the input box.
🔹 **Click ‘Shorten URL’** – The URL will be shortened, and the result will appear below.
🔹 **Switch Between Dark/Light Mode** – Toggle the theme from dark to light mode and vice versa.
🔹 **View Shortened Links** – All your shortened URLs will be displayed in a list.
---
## **Project Structure** 📂
```bash
pages/
│── api/
│ │── shorten.js
│── index.tsx
components/
│── Navbar.js
lib/
│── mongodb.js
public/
│── favicon.ico
styles/
│── globals.css
│── tailwind.css
.env.local
.gitignore
next.config.ts
package.json
README.md
```
---
## **Screenshots 📸**
---
## **Contributing** 🤝
Contributions are welcome! If you’d like to improve LetMeCut, feel free to fork the repo and submit a pull request.
### **Steps to Contribute:**
**Fork the repository**
### **1. Create a new branch:**
```bash
git checkout -b feature-branch
```
### **2. Make your changes and commit:**
```bash
git commit -m "Added new feature"
```
### **3. Push to the branch:**
```bash
git push origin feature-branch
```
### **Open a Pull Request**
---
## **License** 📜
This project is licensed under the MIT License.
💡 Developed with ❤️ by [Mohammad Hashim](https://github.com/mohammadhashim135/let-me-cut.git)