Skip to content
Free Modern URL Shortener.
TypeScript HTML Shell Other
Branch: develop
Clone or download

Latest commit

Latest commit eda3513 May 31, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client fix: remove $ typo May 31, 2020
docs/api (docs): fixed errors in api.ts (#311) May 31, 2020
server fix: type error May 31, 2020
static chor: remove unused images Feb 22, 2020
.babelrc chore: remove unused Jan 6, 2020
.dockerignore Ignore .env (#284) Feb 29, 2020
.eslintignore [v2-beta] Move from Neo4j to Postgres, use TypeScript for server. Fixes Oct 8, 2019
.eslintrc feat: api v2 Jan 30, 2020
.example.env chor: add site name env Feb 5, 2020
.gitignore API doc generation! (#280) Feb 15, 2020
.prettierrc feat: refactor client and improve design (#260) Jan 2, 2020
.template.env Add LINK_LENGTH variable (#254) Dec 27, 2019
.travis.yml Fix travis May 29, 2019
Dockerfile chor: make sure postgres is up before running migrations Feb 22, 2020
LICENSE update year and name Jan 3, 2020
MIGRATION.md Update MIGRATION.md Dec 10, 2019
README.md Remove kutt-bash, closes #312 May 20, 2020
docker-compose.yml chor: make sure postgres is up before running migrations Feb 22, 2020
global.d.ts feat: api v2 Jan 30, 2020
knexfile.ts fix: pass env.DB_SSL to Knex so that migrations succeed with SSL (#316) May 31, 2020
next.config.js fix: move config to root folder Jan 2, 2020
nodemon.json chore: rename ts config Jan 3, 2020
package-lock.json 2.3.16 May 31, 2020
package.json 2.3.16 May 31, 2020
tsconfig.json API doc generation! (#280) Feb 15, 2020
wait-for-it.sh chor: make sure postgres is up before running migrations Feb 22, 2020

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

Migration from v1

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.

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

You can’t perform that action at this time.