ClipLink - URL Shortener

The ultimate URL shortener for seamless link management. Shorten, customize, and track your links with ease. Boost your branding and analytics with a fast, reliable, and user-friendly solution. Try ClipLink today!
Explore the site »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Contact

About The Project

ClipLink is a minimalistic, high-performance URL shortener designed with usability at its core. Whether you're managing a large number of links or just need a quick way to create short, shareable URLs, ClipLink makes it simple and efficient.

Key features:

• Minimalistic Design: Clean and intuitive interface ensures an effortless user experience.
• Third-party authentication: Google and Github authentication.
• Blazing Fast Performance: Optimized backend and frontend deliver instant results.
• Customizable Links: Personalize your short URLs to make them memorable.
• Scalable Architecture: Built to handle growing demands without compromising speed.

Why Choose ClipLink?

ClipLink was crafted with simplicity and performance in mind, making it the perfect tool for users who value ease of use and speed without unnecessary bloat.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow these steps to clone and set up the ClipLink URL Shortener on your local machine:

Prerequisites

Ensure you have the following installed:

1. Node.js (version 16 or higher recommended)
2. pnpm, npm or yarn package manager

Installation

1. Clone the repo

   git clone https://github.com/ososuna/cliplink-rest.git

2. Install NPM packages

   Using pnpm

   pnpm install

   Using npm

   npm install

   Using yarn

   yarn

3. Create a .env file in the root of the project and enter your own environment variables

    PORT=
    MONGO_URL=
    MONGO_DB_NAME=
    JWT_SEED=
    GITHUB_CLIENT_ID=
    GITHUB_CLIENT_SECRET=
    GITHUB_CALLBACK_URL=
    GOOGLE_CLIENT_ID=
    GOOGLE_CLIENT_SECRET=
    GOOGLE_CALLBACK_URL=
    RESEND_API_KEY=
    WEB_APP_URL=

4. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin github_username/repo_name
   git remote -v # confirm the changes

5. Start docker-compose to set up a MongoDB instance in your local

   docker-compose up

6. Start the Development server

   Using pnpm

   pnpm run dev

   Using npm

   npm run dev

   Using yarn

   yarn dev

7. Start the ClipLink UI following the next instructions: https://github.com/ososuna/cliplink-ui?tab=readme-ov-file#getting-started

(back to top)

License

Distributed under the Unlicense License.

(back to top)

Contact

Oswaldo Osuna - oswaldo.adrian35@gmail.com

Project Link: https://github.com/ososuna/cliplink-rest.git

(back to top)