Klip: Kutt like it's perfect. An easy to use self-hosted URL shortener.

Joe authored on 18 Jun
client replace most references to Kutt with Klip 3 months ago
docs/ api replace most references to Kutt with Klip 3 months ago
server remove missed export 3 months ago
static replace most references to Kutt with Klip 3 months ago
.babelrc chore: remove unused 8 months ago
.dockerignore Ignore .env (#284) 7 months ago
.eslintignore Update config 1 year ago
.eslintrc feat: api v2 8 months ago
.example.env replace more occurences of Kutt with Klip 3 months ago
.gitignore API doc generation! (#280) 7 months ago
.prettierrc feat: refactor client and improve design (#260) 9 months ago
.template.env replace more occurences of Kutt with Klip 3 months ago
.travis.yml Fix travis 1 year ago
Dockerfile chor: make sure postgres is up before running migrations 7 months ago
LICENSE update license 3 months ago
MIGRATION.md Update MIGRATION.md 9 months ago
README.md update readme 3 months ago
docker-compose.yml chor: make sure postgres is up before running migrations 7 months ago
global.d.ts feat: api v2 8 months ago
knexfile.ts fix: pass env.DB_SSL to Knex so that migrations succeed with SSL (#316) 4 months ago
next.config.js fix: move config to root folder 9 months ago
nodemon.json chore: rename ts config 9 months ago
package-lock.json rip out Google analytics and reCaptcha 3 months ago
package.json update package 3 months ago
tsconfig.json API doc generation! (#280) 7 months ago
wait-for-it.sh chor: make sure postgres is up before running migrations 7 months ago
README.md

Klip

Klip: Kutt like it's perfect

Klip is a fork of the modern URL shortener known as Kutt, with support for custom domains. Shorten URLs, manage your links and view the click rate statistics.

Contributions and bug reports are welcome.

Demo

https://uwu.ryukyu

Contributions GitHub license

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

  • 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 can use Docker to start the app. The simplest way is to just 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.

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.