# Kutt.it
**Kutt** is a modern URL shortener which lets you set custom domains for your shortened URLs, manage your links and view the click rate statistics.
*Contributions and bug reports are welcome.*
[https://kutt.it](https://kutt.it)
[](https://travis-ci.org/thedevs-network/kutt)
[](https://github.com/thedevs-network/kutt/#contributing)
[](https://github.com/thedevs-network/kutt/blob/develop/LICENSE)
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fthedevs-network%2Fkutt%2F)
## Table of Contents
* [Key Features](#key-features)
* [Stack](#stack)
* [Setup](#setup)
* [API](#api)
* [Contributing](#contributing)
## Key Features
* Free and open source.
* Setting custom domain.
* Using custom URLs for shortened links
* Setting password for links.
* Private statistics for shortened URLs.
* View and manage your links.
* Provided 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](https://nodejs.org/) and [Neo4j](https://neo4j.com/) installed on your system.
1. Clone this repository or [download zip](https://github.com/thedevs-network/kutt/archive/master.zip).
2. Copy `config.example.js` to `config.js` in both server and client folders and fill them properly.
3. Install dependencies: `npm install`.
4. Start Neo4j database.
5. Run for development: `npm run dev`.
6. Run for production: `npm run build` then `npm start`.
**Docker:** You can use Docker to run the app. Read [docker-examples](/docker-examples) for more info.
## API
In additional 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. Do not ever 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 `apikey` in the body of all below requests. Available API URLs with body parameters:
**Get shortened URLs list:**
```
POST /api/url/geturls
```
Returns:
```
{
list {Array} List of URL objects
countAll {number} Amount of items in the list
}
```
**Submit a links to be shortened**:
```
POST /api/url/submit
```
Body:
* `target`: Original long URL to be shortened.
Returns: URL object
**Delete a shortened URL** and **Get stats for a shortened URL:**
```
POST /api/url/deleteurl
POST /api/url/stats
```
Body
* `id`: ID of the shortened URL.
* `domain` (optional): Required if a custom domain is used for short URL.
## Contributing
Pull requests are welcome. You'll probably find lots of improvements to be made.
Open issues for feedback, needed features, reporting bugs or discussing ideas.
Special thanks to [Thomas](https://github.com/trgwii) and [Muthu](https://github.com/MKRhere). Logo design by [Muthu](https://github.com/MKRhere)