Clikit

This is the central repository of clikit.Clikit is a url shortner utility. Follow the instructions below to clone the repository and initialize the submodules.

Features

• User Authentication: Secure user registration and login.
• URL Shortening: Shorten long URLs for easier sharing.
• URL Analytics: Track usage statistics of shortened URLs.
• Custom Domain Integration: Add custom domains for shortened URLs.
• Freemium Model: Free users can add one custom domain; premium users can add multiple.

Tech Stack

Client: React, zustand, TailwindCSS, Shadcn, Recharts

Server: Node, Express, Mongodb, Mongoose, Razorpay, Nginx

Deployment: Nginx, AWS Ec2

Environment Variables

Before running the application, rename the .env.example file to .env and fill all the environment variables.

Run Locally

To clone this repository and initialize the submodules, use the following commands:

# Clone the repository
git clone --recurse-submodules https://github.com/pratyushsingha/clikit

# Navigate into the repository directory
cd clikit

Navigate to submodule repos for dedicated instruction about how to setup the client and the server locally/

Submodule Projects

Here are the submodule repo that this project uses.

• Clikit_Client
• Clikit_Server

API Documentation

On the way(comming soon)