Startseite Erkunden Hilfe
Anmelden
Vieraw
/
Kutt
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki

Free Modern URL Shortener.

Struktur: 43d0c47853
Branches Tags
Kutt
ZIP TAR.GZ
poeti8 43d0c47853 2.3.7 vor 6 Jahren
client ed4d528c8d feat: add delete account section to settings vor 6 Jahren
server ed4d528c8d feat: add delete account section to settings vor 6 Jahren
static b04366ee7c Add browser extionsions section vor 7 Jahren
.babelrc edac550441 chore: remove unused vor 6 Jahren
.dockerignore b8933edde7 chor(docker): update docker for v2 vor 6 Jahren
.eslintignore 33320f0205 [v2-beta] Move from Neo4j to Postgres, use TypeScript for server. Fixes #217, #197, #190, #75 (#220) vor 6 Jahren
.eslintrc 25903bf3cd feat: api v2 vor 6 Jahren
.example.env cbc0470550 chor: add site name env vor 6 Jahren
.gitignore b377b96a0e chor: ignore dump.rdb vor 6 Jahren
.prettierrc 4680a0dbec feat: refactor client and improve design (#260) vor 6 Jahren
.template.env 7be595c3cc Add LINK_LENGTH variable (#254) vor 6 Jahren
.travis.yml 6fa59d026c Fix travis vor 6 Jahren
Dockerfile b8933edde7 chor(docker): update docker for v2 vor 6 Jahren
LICENSE ddc52f8b7c update year and name vor 6 Jahren
MIGRATION.md 00494abc38 Update MIGRATION.md vor 6 Jahren
README.md e1a5cd76fb docs: add swagger api link vor 6 Jahren
docker-compose.yml b8933edde7 chor(docker): update docker for v2 vor 6 Jahren
global.d.ts 25903bf3cd feat: api v2 vor 6 Jahren
knexfile.ts 8f58452f4c chor: add migrations and add new column constraints vor 6 Jahren
next.config.js 40bb10ce4c fix: move config to root folder vor 6 Jahren
nodemon.json b83ce016dd chore: rename ts config vor 6 Jahren
package-lock.json 5f1b7f5bd4 2.3.7 vor 6 Jahren
package.json 5f1b7f5bd4 2.3.7 vor 6 Jahren
tsconfig.json b83ce016dd chore: rename ts config vor 6 Jahren

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.