Klip: Kutt like it's perfect. An easy to use self-hosted URL shortener.
Go to file
Joe 6506136f67
continuous-integration/drone/push Build is passing Details
[ci] update drone config
2021-08-28 03:03:21 -05:00
client update header 2021-08-28 02:33:25 -05:00
docs/api resolve conflicts after cherry-pick 2021-08-27 17:07:51 -05:00
server merge with upstream tag v2.6.0 2021-08-27 17:35:50 -05:00
static update logo in readme 2021-08-28 02:52:26 -05:00
.babelrc chore: remove unused 2020-01-06 21:11:06 +03:30
.dockerignore Ignore .env (#284) 2020-02-29 23:35:14 +03:30
.drone.yml [ci] update drone config 2021-08-28 03:03:21 -05:00
.eslintignore [v2-beta] Move from Neo4j to Postgres, use TypeScript for server. Fixes #217, #197, #190, #75 (#220) 2019-10-08 21:56:03 +03:30
.eslintrc double max line length for code as well as comments 2020-09-04 14:27:59 -05:00
.example.env merge with upstream tag v2.6.0 2021-08-27 17:35:50 -05:00
.gitattributes enable lfs 2021-08-28 02:08:15 -05:00
.gitignore API doc generation! (#280) 2020-02-15 21:32:10 +03:30
.prettierrc feat: refactor client and improve design (#260) 2020-01-02 20:09:59 +03:30
.template.env replace more occurences of Kutt with Klip 2020-06-18 12:20:04 -05:00
.travis.yml chore: remove scripts with error 2020-07-25 16:17:50 +04:30
Dockerfile chor: make sure postgres is up before running migrations 2020-02-22 16:05:51 +03:30
LICENSE [ci] test pipeline 2020-09-04 10:01:30 -05:00
MIGRATION.md Update MIGRATION.md 2019-12-10 12:33:52 +03:30
README.md correct readme logo src and dimensions 2021-08-28 02:57:13 -05:00
btc.png enable lfs 2021-08-28 02:08:15 -05:00
docker-compose.yml feat: sanitize docker-compose (#360) 2020-07-28 19:31:53 +04:30
global.d.ts resolve conflicts after cherry-pick 2021-08-27 17:07:51 -05:00
knexfile.ts fix: pass env.DB_SSL to Knex so that migrations succeed with SSL (#316) 2020-05-31 12:02:44 +04:30
next.config.js merge with upstream tag v2.6.0 2021-08-27 17:35:50 -05:00
nodemon.json chore: rename ts config 2020-01-03 18:21:53 +03:30
package-lock.json merge with upstream tag v2.6.0 2021-08-27 17:35:50 -05:00
package.json merge with upstream tag v2.6.0 2021-08-27 17:35:50 -05:00
tsconfig.json API doc generation! (#280) 2020-02-15 21:32:10 +03:30
wait-for-it.sh chor: make sure postgres is up before running migrations 2020-02-22 16:05:51 +03:30

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.