Klip: Kutt like it's perfect. An easy to use self-hosted URL shortener. https://uwu.ryukyu/
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 0270641540
replace missed reference to GitHub in header
пре 1 месец
client replace missed reference to GitHub in header пре 1 месец
docs/api replace most references to Kutt with Klip пре 4 месеци
server replace references to unsafe url-regex пре 1 месец
static replace most references to Kutt with Klip пре 4 месеци
.babelrc chore: remove unused пре 9 месеци
.dockerignore Ignore .env (#284) пре 8 месеци
.drone.yml [ci] give klip server more time to start up (migrations take a while) пре 1 месец
.eslintignore [v2-beta] Move from Neo4j to Postgres, use TypeScript for server. Fixes #217, #197, #190, #75 (#220) пре 1 година
.eslintrc double max line length for code as well as comments пре 1 месец
.example.env allow custom domain support to be toggled and IP to be configured пре 1 месец
.gitignore API doc generation! (#280) пре 8 месеци
.prettierrc feat: refactor client and improve design (#260) пре 10 месеци
.template.env replace more occurences of Kutt with Klip пре 4 месеци
.travis.yml Fix travis пре 1 година
Dockerfile chor: make sure postgres is up before running migrations пре 8 месеци
LICENSE [ci] test pipeline пре 1 месец
MIGRATION.md Update MIGRATION.md пре 10 месеци
README.md add anchor prefix to contributions badge пре 1 месец
docker-compose.yml chor: make sure postgres is up before running migrations пре 8 месеци
global.d.ts feat: api v2 пре 9 месеци
knexfile.ts fix: pass env.DB_SSL to Knex so that migrations succeed with SSL (#316) пре 5 месеци
next.config.js fix: move config to root folder пре 10 месеци
nodemon.json chore: rename ts config пре 10 месеци
package-lock.json bump version пре 1 месец
package.json bump version пре 1 месец
tsconfig.json API doc generation! (#280) пре 8 месеци
wait-for-it.sh chor: make sure postgres is up before running migrations пре 8 месеци

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 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.