Klip: Kutt like it's perfect. An easy to use self-hosted URL shortener.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Joe 6506136f67
[ci] update drone config
4 weeks ago
client update header 4 weeks ago
docs/api resolve conflicts after cherry-pick 4 weeks ago
server merge with upstream tag v2.6.0 4 weeks ago
static update logo in readme 4 weeks ago
.babelrc chore: remove unused 2 years ago
.dockerignore Ignore .env (#284) 2 years ago
.drone.yml [ci] update drone config 4 weeks ago
.eslintignore Update config 2 years ago
.eslintrc double max line length for code as well as comments 1 year ago
.example.env merge with upstream tag v2.6.0 4 weeks ago
.gitattributes enable lfs 4 weeks ago
.gitignore API doc generation! (#280) 2 years ago
.prettierrc feat: refactor client and improve design (#260) 2 years ago
.template.env replace more occurences of Kutt with Klip 1 year ago
.travis.yml chore: remove scripts with error 1 year ago
Dockerfile chor: make sure postgres is up before running migrations 2 years ago
LICENSE [ci] test pipeline 1 year ago
MIGRATION.md Update MIGRATION.md 2 years ago
README.md correct readme logo src and dimensions 4 weeks ago
btc.png enable lfs 4 weeks ago
docker-compose.yml feat: sanitize docker-compose (#360) 1 year ago
global.d.ts feat: add link expiration 1 year ago
knexfile.ts fix: pass env.DB_SSL to Knex so that migrations succeed with SSL (#316) 1 year ago
next.config.js merge with upstream tag v2.6.0 4 weeks ago
nodemon.json chore: rename ts config 2 years ago
package-lock.json merge with upstream tag v2.6.0 4 weeks ago
package.json merge with upstream tag v2.6.0 4 weeks ago
tsconfig.json API doc generation! (#280) 2 years ago
wait-for-it.sh chor: make sure postgres is up before running migrations 2 years ago

README.md

Klip

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.

Contributions 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 need to run the app with the required envrironment variables listed in .example.env.

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.