Domů Procházet Nápověda
Přihlásit se
Vieraw
/
Kutt
1
0
Rozštěpit 0
Soubory Úkoly 0 Pull Requesty 0 Wiki

Free Modern URL Shortener.

Strom: 6af694826d
Větve Značky
Kutt
ZIP TAR.GZ
Pouria Ezzati 6af694826d 👾 před 8 roky
client 6af694826d 👾 před 8 roky
server 6af694826d 👾 před 8 roky
static 6af694826d 👾 před 8 roky
.babelrc 6af694826d 👾 před 8 roky
.env 6af694826d 👾 před 8 roky
.eslintignore 6af694826d 👾 před 8 roky
.eslintrc 6af694826d 👾 před 8 roky
.gitignore 6af694826d 👾 před 8 roky
.travis.yml 6af694826d 👾 před 8 roky
LICENSE 6af694826d 👾 před 8 roky
README.md 6af694826d 👾 před 8 roky
package-lock.json 6af694826d 👾 před 8 roky
package.json 6af694826d 👾 před 8 roky

README.md

Kutt.it

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

Build Status Contributions GitHub license Twitter

Table of Contents

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 and Neo4j installed on your system.

  1. Clone this repository on downlaod 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.

API

In additional to website, you can use these APIs to create, delete and get URLs.

In order to use these APIs you need to generate an API key from settings. Don not ever put this key in the client side of your app or anywhere that is exposed to others.

Include 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

Submit a links to be shortened:

POST /api/url/submit

Body:

  • target: Original long URL to be shortened.

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 feadback, needed features, reporting bugs or discussing ideas.