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.
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)
- Neo4j (Graph database)
Setup
You need to have Node.js, Neo4j and Redis installed on your machine.
- Clone this repository or download zip.
- Copy
.example.env
to.env
and fill it properly. - Install dependencies:
npm install
. - Start Neo4j database.
- Run for development:
npm run dev
. - Run for production:
npm run build
thennpm start
.
Visit our wiki for a more complete setup and development guide.
Docker: You can use Docker to run the app. Read docker-examples for more info.
Browser Extensions
Download Kutt's extension for web browsers via below links. You can also find the source code on kutt-extension.
API
In addition to the website, you can use these APIs to create, delete and get URLs.
Types
URL {
createdAt {string} ISO timestamp of when the URL was created
id {string} Unique ID of the URL
target {string} Where the URL will redirect to
password {boolean} Whether or not a password is required
count {number} The amount of visits to this URL
shortUrl {string} The shortened link (Usually https://kutt.it/id)
}
In order to use these APIs you need to generate an API key from settings. Never put this key in the client side of your app or anywhere that is exposed to others.
All API requests and responses are in JSON format.
Include the API key as X-API-Key
in the header of all below requests. Available API endpoints with body parameters:
Get shortened URLs list:
GET /api/url/geturls
Returns:
{
list {Array<URL>} List of URL objects
countAll {number} Amount of items in the list
}
Submit a link to be shortened:
POST /api/url/submit
Body:
target
: Original long URL to be shortened.customurl
(optional): Set a custom URL.password
(optional): Set a password.reuse
(optional): If a URL with the specified target exists returns it, otherwise will send a new shortened URL.
Returns: URL object
Delete a shortened URL and Get stats for a shortened URL:
POST /api/url/deleteurl
GET /api/url/stats
Body (or query for GET request)
id
: ID of the shortened URL.domain
(optional): Required if a custom domain is used for short URL.
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 API 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 | 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 |
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.