Klip: Kutt like it's perfect

Klip is a fork of the URL shortener known as Kutt. Klip has dropped support for Google ReCaptcha, and allows custom domains to be disabled.

Contributions and bug reports are welcome.

Migration from v1

If you're coming from v1, refer to MIGRATION.md to migrate data from Neo4j to PostgreSQL.

Table of Contents

• Key Features
• Stack
• Setup
• Browser Extensions
• API
• Integrations
• 3rd Party Packages
• Contributing

Key Features

• Free and open source.
• Custom domain support.
• Custom URLs for shortened links
• Setting password for links.
• Private statistics for shortened URLs.
• View and manage your links.
• RESTful API.

Stack

• Node (Web server)
• Express (Web server framework)
• Passport (Authentication)
• React (UI library)
• Next (Universal/server-side rendered React)
• Easy Peasy (State management)
• styled-components (CSS styling solution library)
• Recharts (Chart library)
• PostgreSQL (database)
• Redis (Cache layer)

Setup

You need to have Node.js, PostgreSQL and Redis installed.

1. Clone this repository.
2. Copy .example.env to .env and fill it properly.
3. Install dependencies: npm install.
4. Run for development: npm run dev.
5. Run for production: npm run build then npm start.

Docker

You need to run the app with the required envrironment variables listed in .example.env.

• Official Docker hub image.
• Or simply run docker-compose up command and then the app should be ready on port "3000".

Browser Extensions

Kutt's extensions for web browsers stil work with Klip! Download them via the below links. You can also find the source code at kutt-extension.

• Chrome
• Firefox

API

Visit API v2 documentation on docs.kutt.it

Integrations

ShareX

You can use Kutt as your default URL shortener in ShareX. If you host your custom instance of Kutt, refer to ShareX wiki on how to setup.

Alfred Workflow

Download Kutt's official workflow for Alfred app from alfred-kutt repository.

3rd Party packages

Language	Link	Description
C# (.NET)	KuttSharp	.NET package for Kutt.it url shortener
Python	kutt-cli	Command-line client for Kutt written in Python
Ruby	kutt.rb	Kutt library written in Ruby
Rust	urlshortener	URL shortener library written in Rust
Rust	kutt-rs	Command line tool written in Rust
Node.js	node-kutt	Node.js client for Kutt.it url shortener
JavaScript	kutt-vscode	Visual Studio Code extention for Kutt
Java	kutt-desktop	A Cross platform Java desktop application for Kutt
Go	kutt-go	Go client for Kutt.it url shortener

Contributing

Pull requests are welcome. You'll probably find lots of improvements to be made.

Open issues for feedback, requesting features, reporting bugs or discussing ideas.

Special thanks to Thomas and Muthu. Logo design by Muthu.