https://github.com/freecode911/minolink
Minolink: a Node.js and MongoDB-based URL shortener that creates easy-to-share short links.
https://github.com/freecode911/minolink
free minolink mongodb nodejs url url-shortener
Last synced: about 1 year ago
JSON representation
Minolink: a Node.js and MongoDB-based URL shortener that creates easy-to-share short links.
- Host: GitHub
- URL: https://github.com/freecode911/minolink
- Owner: FreeCode911
- License: gpl-3.0
- Created: 2024-08-24T13:39:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-25T11:19:57.000Z (over 1 year ago)
- Last Synced: 2025-01-18T00:13:43.480Z (over 1 year ago)
- Topics: free, minolink, mongodb, nodejs, url, url-shortener
- Language: EJS
- Homepage: https://minolink.us.kg/
- Size: 4.31 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# URL Shortener
A simple URL shortening web application built with Node.js, Express, and MongoDB.
## ScreenShot
### Mobile View
### Desktop View
## Features
- Shorten long URLs to concise and shareable short links.
- Copy short URLs to the clipboard with a click.
## Getting Started
### Prerequisites
- Node.js installed
- MongoDB installed and running
### Installation
1. Clone the repository:
```bash
git clone https://github.com/FreeCode911/Minolink.git
```
2. Navigate to the project directory:
```bash
cd url-shortener
```
3. Install dependencies:
```bash
npm install
```
4. Open file named `config.json` in the project root:
```json
{
"mongodb_url": "mongodb+srv://admin:admin@lykcloud.me/url-shortener", //Remove In MongoDB ( ?retryWrites=true&w=majority ) EG:- mongodb+srv://USERNAME:PASSWORD@xx/ANY_NAME
"port": 3000,
"website_url": "https://example.com", //Website Url Must Be https://example.com Do Not Add https://example.com/ , https://example.com//, etc..
}
```
### Usage
1. Start the application:
```bash
npm start
```
2. Open your browser and visit [https://your-domain.com](https://domain.com).
3. Enter a long URL in the input box and click "Shorten URL."
4. Copy the generated short URL and share it!
### Configuration
You can customize the website URL by modifying the `config.json` file.