ホーム エクスプローラ ヘルプ
サインイン
Vieraw
/
Kutt
1
0
フォーク 0
ファイル 課題 0 プルリクエスト 0 Wiki

Free Modern URL Shortener.

ツリー: v2.3.17
ブランチ タグ
Kutt
ZIP TAR.GZ
poeti8 44b786d1e2 2.3.17 5 年 前
client 474d09e382 feat: allow multiple custom domains (#317) 5 年 前
docs ac8649430f (docs): fixed errors in api.ts (#311) 5 年 前
server 474d09e382 feat: allow multiple custom domains (#317) 5 年 前
static f658e8bab9 chor: remove unused images 5 年 前
.babelrc edac550441 chore: remove unused 6 年 前
.dockerignore b6884ea1aa Ignore .env (#284) 5 年 前
.eslintignore 33320f0205 [v2-beta] Move from Neo4j to Postgres, use TypeScript for server. Fixes #217, #197, #190, #75 (#220) 6 年 前
.eslintrc 25903bf3cd feat: api v2 6 年 前
.example.env cbc0470550 chor: add site name env 6 年 前
.gitignore 2c261ad4af API doc generation! (#280) 6 年 前
.prettierrc 4680a0dbec feat: refactor client and improve design (#260) 6 年 前
.template.env 7be595c3cc Add LINK_LENGTH variable (#254) 6 年 前
.travis.yml 6fa59d026c Fix travis 6 年 前
Dockerfile 70c1267df4 chor: make sure postgres is up before running migrations 5 年 前
LICENSE ddc52f8b7c update year and name 6 年 前
MIGRATION.md 00494abc38 Update MIGRATION.md 6 年 前
README.md 1aef5e3544 Remove kutt-bash, closes #312 5 年 前
docker-compose.yml 70c1267df4 chor: make sure postgres is up before running migrations 5 年 前
global.d.ts 25903bf3cd feat: api v2 6 年 前
knexfile.ts 1b70e84513 fix: pass env.DB_SSL to Knex so that migrations succeed with SSL (#316) 5 年 前
next.config.js 40bb10ce4c fix: move config to root folder 6 年 前
nodemon.json b83ce016dd chore: rename ts config 6 年 前
package-lock.json 314ba0c833 2.3.17 5 年 前
package.json 314ba0c833 2.3.17 5 年 前
tsconfig.json 2c261ad4af API doc generation! (#280) 6 年 前
wait-for-it.sh 70c1267df4 chor: make sure postgres is up before running migrations 5 年 前

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.