https://github.com/slaveofcode/pendekin
Simple self-hosted shorthner url app that produce short url with primary service based on RESTful API
https://github.com/slaveofcode/pendekin
api-rest api-shortener link-shortener rest-api restful-api self-hosted shortener shortener-rest url-shortener
Last synced: 8 months ago
JSON representation
Simple self-hosted shorthner url app that produce short url with primary service based on RESTful API
- Host: GitHub
- URL: https://github.com/slaveofcode/pendekin
- Owner: slaveofcode
- License: mit
- Created: 2017-08-28T08:32:22.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-20T10:48:47.000Z (about 8 years ago)
- Last Synced: 2025-01-20T15:23:36.520Z (10 months ago)
- Topics: api-rest, api-shortener, link-shortener, rest-api, restful-api, self-hosted, shortener, shortener-rest, url-shortener
- Language: JavaScript
- Homepage:
- Size: 190 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pendekin
Simple self-hosted shorthener url app that produce short url with primary service based on RESTful API
## Features
- Shorten url based on RESTful
- One-time usage for shorten url after visit (will be deleted)
- Checking availibility for custom-requested shortener code
- Password-protected shorten url
- Multi url listing with one shortened url
- Prefix shortened code
- Bulk shorten urls
- Changing existing destination url on shortened url
- Optional using redis for boosting performance
- Simple Dashboard to manage existing shortened urls **(soon)**
- Categorized shorten urls (on your dashboard) **(soon..)**
- Side-effects trigger on url visitting (http request, email notification, push notification, slack webhook) **(soon..)**
## Requirements
- Redis (optional)
- Postgreql
- Nodejs >= 7.6
## Installation
- Install node `>= 7.6` (8 LTS is preferred)
- Install redis (optional)
- Setup the database configuration on `config/database.json`
- Setup the site configuration on `config/site.json`, set `use_redis` to `false` if you prefer to not using redis, and change all the settings that matched with yours
- Run the migration by `npm run db:migrate`
- Run the seeds by `npm run db:seed:all`
- That's it. check your client table to get `client_key` and `client_secret` to start creating shortener of url
## Rest & Site Redirection
Soon...
## License
MIT