thedevs-network / kutt
- четверг, 15 февраля 2018 г. в 03:15:26
Free Modern URL Shortener.
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.
You need to have Node.js and Neo4j installed on your system.
config.example.js
to config.js
in both server and client folders and fill them properly.npm install
.npm run dev
.npm run build
then npm start
.In additional to website, you can use these APIs to create, delete and get URLs.
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. Don 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 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<URL>} 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.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.