https://github.com/brussell98/s
Short and simple link shortening
https://github.com/brussell98/s
javascript link-shortener mongodb restify shorten-urls shortener vue vuejs vuetify
Last synced: 6 months ago
JSON representation
Short and simple link shortening
- Host: GitHub
- URL: https://github.com/brussell98/s
- Owner: brussell98
- License: mit
- Created: 2018-03-16T23:20:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-11T07:51:35.000Z (about 7 years ago)
- Last Synced: 2025-03-28T08:51:18.641Z (6 months ago)
- Topics: javascript, link-shortener, mongodb, restify, shorten-urls, shortener, vue, vuejs, vuetify
- Language: JavaScript
- Size: 1.1 MB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](http://restify.com/) server for the back-end. The front-end is built with [VueJS](https://vuejs.org/), and uses [Vuetify](https://vuetifyjs.com/) for the UI.
## Installation
> **s** requires [NodeJS](https://nodejs.org/en/) 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
- [x] MongoDB
- [ ] PostgreSQL
API Server
- [ ] Restify server
- [x] Visit link
- [x] Shorten url
- [x] Delete link
- [x] Create account
- [x] Authenticate
- [x] Change password
- [x] 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
- [x] Short id generator
Website
- [x] Main functions
- [x] Shorten link
- [x] URL Validation
- [x] View links
- [x] Delete links
- [x] Accounts
- [x] Create
- [x] Log in
- [x] Change password
- [ ] Error/failure display
Link analytics
- [x] Link visited
- [x] Created at