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

poeti8 authored on 15 Feb
client feat: add delete account section to settings 4 months ago
server feat: add delete account section to settings 4 months ago
static Add browser extionsions section 1 year ago
.babelrc chore: remove unused 6 months ago
.dockerignore chor(docker): update docker for v2 8 months ago
.eslintignore Update config 10 months ago
.eslintrc feat: api v2 5 months ago
.example.env chor: add site name env 5 months ago
.gitignore chor: ignore dump.rdb 6 months ago
.prettierrc feat: refactor client and improve design (#260) 6 months ago
.template.env Add LINK_LENGTH variable (#254) 6 months ago
.travis.yml Fix travis 1 year ago
Dockerfile chor(docker): update docker for v2 8 months ago
LICENSE update year and name 6 months ago
MIGRATION.md Update MIGRATION.md 7 months ago
README.md docs: add swagger api link 5 months ago
docker-compose.yml chor(docker): update docker for v2 8 months ago
global.d.ts feat: api v2 5 months ago
knexfile.ts chor: add migrations and add new column constraints 4 months ago
next.config.js fix: move config to root folder 6 months ago
nodemon.json chore: rename ts config 6 months ago
package-lock.json 2.3.7 4 months ago
package.json 2.3.7 4 months ago
tsconfig.json chore: rename ts config 6 months ago
README.md

Kutt.it

Kutt.it

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

Contributions and bug reports are welcome.

https://kutt.it

Build Status Contributions GitHub license Twitter

Kutt v2 (🚧 beta)

The new version of Kutt is here. In version 2, we used TypeScript and we moved from Neo4j to PostgreSQL database in favor of performance and we're working on adding new features.

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

You can still find the stable version (v1) in the v1 branch.

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)
  • Redux (State management)
  • styled-components (CSS styling solution library)
  • Recharts (Chart library)
  • PostgreSQL (database)

Setup

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

  1. Clone this repository or download zip.
  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

Download Kutt's extension for web browsers via below links. You can also find the source code on kutt-extension.

API

Visit API v2 documentation on Swagger

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
Bash kutt-bash Simple command line program for Kutt
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.