Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/123brijesh44aa/li.ly
https://github.com/123brijesh44aa/li.ly
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/123brijesh44aa/li.ly
- Owner: 123Brijesh44aa
- Created: 2024-06-22T09:36:01.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-22T11:17:06.000Z (7 months ago)
- Last Synced: 2024-11-07T07:49:19.392Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌐 URL Shortener API
A powerful and efficient URL shortener API built with Node.js, Express.js, and MongoDB. Transform long URLs into concise, easy-to-share short links!
## ✨ Features
- 🔗 **Create Short URLs:** Instantly convert long URLs into short, manageable links.
- 📋 **Retrieve All URLs:** Fetch all stored URLs effortlessly.
- 🔍 **Get Specific URL:** Retrieve original URLs using short URLs.
- 🚀 **Redirect:** Seamlessly redirect to original URLs via short links.
- ✏️ **Update URLs:** Modify original URLs as needed.
- 🗑️ **Delete URLs:** Remove URLs by their short links.
## 📋 Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [License](#license)
## 🔧 Prerequisites
- Node.js and npm installed on your machine.
- MongoDB installed and running, or access to a MongoDB cloud service (e.g., MongoDB Atlas).
## 🛠️ Installation
1. **Clone the repository:**
```bash
git clone https://github.com/123Brijesh44aa/Li.ly.git
cd url-shortener-api
2. **Install the dependencies:**
```bash
npm install
3. **Create a .env file in the root directory:**
```bash
PORT=5000
MONGODB_URI=your_mongodb_uri
BASE_URL=http://localhost:5000
4. **Start the server:**
```bash
npm start
## 📜 License
**This project is licensed under the MIT License. See the LICENSE file for details.**
```bash
This version includes the installation instructions, environment configuration, server startup commands, example cURL commands, and code examples for each API endpoint. This should make your README.md both comprehensive and user-friendly.