LinkSimplify

LinkSimplify is a powerful and user-friendly URL shortener designed to streamline the sharing of links across various platforms. This project features both a web interface and an API, allowing users to easily create, update, and delete shortened URLs as needed.

Table of Contents

• Features
• Demo
• Installation
• Usage
• Contributing
• License
• External Credits
• Docker Support

Features

• User authentication (register, login, logout)
• URL shortening with custom aliases
• Blacklist for custom aliases (reserved keywords)
• URL management (edit, delete)
• URL analytics (click tracking)
• Social Media Sharing
• QR Code Generation
• Responsive design
• Secure password storage with bcrypt
• JWT-based authentication
• Docker support
• API Access (planned)
• Extendable with additional features (planned)
• Custom Domain Support (planned)
• Password-protected URLs (planned)
• Expiration Dates (planned)
• Rate Limiting (planned)
• Google Analytics Integration (planned)
• API Key Authentication (planned)
• Geo Location Tracking (planned)
• Logging and Monitoring (planned)
• Spam Protection (planned)
• Abuse Prevention (planned)

Demo

LinkSimplify Demo
Users can register with any credentials.

Installation

To get started with LinkSimplify, follow these steps:

1. Clone the repository:

   git clone https://github.com/mezbaulanam/LinkSimplify.git

2. Navigate to the project directory:

   cd LinkSimplify

3. Install the dependencies:

   npm install

4. Create a .env file in the root directory and add your environment variables:

   MONGODB_URI=your_mongodb_uri
   JWT_SECRET=your_jwt_secret

5. Start the development server:

   npm start

Docker Support

LinkSimplify can be easily set up using Docker. Follow these steps to run the application in a Docker container:

1. Build the Docker image:

   docker build -t linksimplify .

2. Run the Docker container:

   docker run -p 3000:3000 --env-file .env linksimplify

Alternatively, you can use Docker Compose to manage the setup:

1. Build and start the services:

   docker-compose up --build

2. The application will be available at http://localhost:3000.

Usage

1. Open your browser and navigate to http://localhost:3000.
2. Register a new account or log in with an existing account.
3. Use the URL shortener form to create a new shortened URL.
4. Manage your URLs from the dashboard.

Contributing

We welcome contributions from the community! Please read our Contributing Guide to get started.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

External Credits

• Free SVG Backgrounds and Patterns by SVGBackgrounds.com

---

Made with ❤️ by mezbaulanam