Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pulkitgarg04/shortzoid
ShortZoid is a URL Shortening and QR Code Generating website
https://github.com/pulkitgarg04/shortzoid
chartjs ejs express file-saver mongodb nodejs url-shortener
Last synced: 3 days ago
JSON representation
ShortZoid is a URL Shortening and QR Code Generating website
- Host: GitHub
- URL: https://github.com/pulkitgarg04/shortzoid
- Owner: pulkitgarg04
- License: mit
- Created: 2024-08-12T04:58:55.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T07:06:10.000Z (about 2 months ago)
- Last Synced: 2024-10-17T13:18:09.576Z (20 days ago)
- Topics: chartjs, ejs, express, file-saver, mongodb, nodejs, url-shortener
- Language: JavaScript
- Homepage: https://shortzoid.vercel.app
- Size: 648 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ShortZoid
ShortZoid is a powerful tool designed to simplify the process of shortening URLs while providing advanced tracking capabilities. Whether you’re a marketer, developer, or everyday user, ShortZoid helps you manage and analyze your links with ease.
### Features
- **Effortless URL Shortening**: Instantly create shortened URLs for easy sharing.
- **QR Code Generation**: Generate QR codes for any shortened link to enhance offline sharing.
- **Comprehensive Analytics**: Track clicks, devices, and browsers with detailed visit history.
- **User-friendly Dashboard**: Access and manage all your shortened URLs in one intuitive interface.
### Tech Stack
- Backend: Node.js (Express.js)
- Frontend: EJS (Embedded JavaScript)
- Database: MongoDB
### Prerequisites
Before you begin, ensure you have the following installed:
- Node.js (14+)
- MongoDB Atlas
- npm or yarn
### Usage
Open your browser and navigate to [ShortZoid](https://shortzoid.vercel.app/).
- Sign up or log in to your account.
- Once logged in, enter the URL you want to shorten in the provided field.
- Click "Generate" to generate a shortened link and QR Code.
- Access additional features such as generating QR codes, tracking clicks, and viewing your URL history from your dashboard.
- Copy your shortened URL or Download the QR Code and share it with others!
### Run Locally
Clone the project
```bash
git clone https://github.com/pulkitgarg04/shortzoid
```
Go to the project directory
```bash
cd shortzoid
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run start
```
### Environment Variables
To run this project, you will need to add the following environment variables to your .env file:
`PORT`
`SECRET`
`MONGODB_URL`
`EMAIL`
`EMAIL_PASSWORD`
`IPSTACK_API_KEY`
### Contributing
We appreciate your interest in contributing to ShortZoid! Your contributions help us improve and grow. Please feel free to submit pull requests, report issues, or suggest new features. Your feedback and participation are highly valued as we continue to develop and enhance the platform.
### License
This project is licensed under the MIT License - see the LICENSE.md file for details.