brussell98 / s

Short and simple link shortening

Short and simple link shortening

s provides an easy way to set up a self-hosted link shortener on your server.

s uses a JavaScript Restify server for the back-end. The front-end is built with VueJS, and uses Vuetify for the UI.

Installation

s requires NodeJS to be installed. Version 8+ is recommended.

1. Install the dependencies by running yarn or npm i --production
2. Copy config/config.ex.js to config/config.js and edit the config to your needs
3. Run s with yarn run or node ./server.js or pm2 ./pm2.json

Planned Features

Support for multiple databases

• MongoDB
• PostgreSQL

API Server

• Restify server

  • Visit link
  • Shorten url
  • Delete link
  • Create account
  • Authenticate
  • Change password
  • Get links for user
  • Ratelimit
    • Custom ratelimiter that isn't garbage

• Express re-write

  • Link routes
  • Authentication routes
  • Authentication handler
  • Rate-limiting with per-route options
  • Optional static file serving

• Short id generator

Website

• Main functions
  • Shorten link
    • URL Validation
  • View links
  • Delete links
• Accounts
  • Create
  • Log in
  • Change password
• Error/failure display

Link analytics

• Link visited
• Created at

s's Issues

Can't start

Hello, when I try to run s with one of the methods included in the README, it always gives me an error: "Error: Cannot find module './config/config.js'". Could you please fix this error?