https://github.com/parimal-paramanik/url-sortner
https://github.com/parimal-paramanik/url-sortner
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/parimal-paramanik/url-sortner
- Owner: parimal-paramanik
- Created: 2023-07-29T09:45:10.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-29T09:59:36.000Z (almost 3 years ago)
- Last Synced: 2024-12-27T05:08:41.574Z (over 1 year ago)
- Language: JavaScript
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# URL Shortener
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Contributing](#contributing)
## Introduction
URL Shortener is a simple web application that allows users to shorten long URLs into short and easily shareable links. The project aims to provide a user-friendly interface for generating short URLs, making it convenient for users to share links on social media platforms, emails, or any other medium with character limits.
## Features
- Shorten long URLs into compact and shareable links.
- Customizable short URLs (if not already taken).
- Redirect users to the original long URL when they access the shortened link.
- Analytics tracking to monitor the usage of shortened URLs (e.g., number of clicks, geographic locations, etc.).
## Technologies Used
- **Frontend**: React js , Tailwind Css
- **Backend**: Node.js, Express.js
- **Database**: MongoDB
- **Deployment**: Netlify,render
## Getting Started
To run the URL Shortener project locally, follow these steps:
1. Clone the repository: `git clone https://github.com/your-username/url-shortener.git`
2. cd into backend `cd backend`
3. Install the required dependencies: `npm install`
4. Set up the MongoDB database. remote url in .env file
5. Start the server: `npm start` start the backend on required port
6. Then `cd frontend`
7. Then change the backend URl in .env file
8. Open your web browser and visit `http://localhost:3000`
## Usage
1. On the homepage, enter the long URL you want to shorten.
2. Click on the "Shorten" button to generate the short URL.
3. The shortened URL will be displayed along with statistics (e.g., number of clicks).
4. Users can copy the short URL and share it with others.
## API Endpoints
there are 3
## Contributing
We welcome contributions to the URL Shortener project. If you find a bug or have an idea for improvement, please feel free to open an issue or submit a pull request.
1. Fork the repository.
2. Create your feature branch: `git checkout -b feature/your-feature-name`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin feature/your-feature-name`
5. Open a pull request explaining your changes.