{"id":17347108,"url":"https://github.com/brussell98/s","last_synced_at":"2025-04-14T20:43:01.467Z","repository":{"id":240684852,"uuid":"125579653","full_name":"brussell98/s","owner":"brussell98","description":"Short and simple link shortening","archived":false,"fork":false,"pushed_at":"2018-07-11T07:51:35.000Z","size":1157,"stargazers_count":12,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T08:51:18.641Z","etag":null,"topics":["javascript","link-shortener","mongodb","restify","shorten-urls","shortener","vue","vuejs","vuetify"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brussell98.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-16T23:20:01.000Z","updated_at":"2023-10-20T21:36:42.000Z","dependencies_parsed_at":"2024-05-20T16:12:41.764Z","dependency_job_id":"d182af3a-9f9b-42ac-959a-98aac2e90f98","html_url":"https://github.com/brussell98/s","commit_stats":null,"previous_names":["brussell98/s"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brussell98%2Fs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brussell98%2Fs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brussell98%2Fs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brussell98%2Fs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brussell98","download_url":"https://codeload.github.com/brussell98/s/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248960096,"owners_count":21189978,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","link-shortener","mongodb","restify","shorten-urls","shortener","vue","vuejs","vuetify"],"created_at":"2024-10-15T16:47:38.880Z","updated_at":"2025-04-14T20:43:01.422Z","avatar_url":"https://github.com/brussell98.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://github.com/brussell98/s/blob/master/logo.png?raw=true\"/\u003e\n\u003c/p\u003e\n\n# Short and simple link shortening\n\n**s** provides an easy way to set up a self-hosted link shortener on your server.\n\n**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.\n\n## Installation\n\n\u003e **s** requires [NodeJS](https://nodejs.org/en/) to be installed. Version 8+ is recommended.\n\n1. Install the dependencies by running `yarn` or `npm i --production`\n2. Copy `config/config.ex.js` to `config/config.js` and edit the config to your needs\n3. Run **s** with `yarn run` or `node ./server.js` or `pm2 ./pm2.json`\n\n## Planned Features\n\nSupport for multiple databases\n\n- [x] MongoDB\n- [ ] PostgreSQL\n\nAPI Server\n\n- [ ] Restify server\n\t- [x] Visit link\n\t- [x] Shorten url\n\t- [x] Delete link\n\t- [x] Create account\n\t- [x] Authenticate\n\t- [x] Change password\n\t- [x] Get links for user\n\t- [ ] Ratelimit\n\t\t- [ ] Custom ratelimiter that isn't garbage\n\n- [ ] Express re-write\n\t- [ ] Link routes\n\t- [ ] Authentication routes\n\t- [ ] Authentication handler\n\t- [ ] Rate-limiting with per-route options\n\t- [ ] Optional static file serving\n\n- [x] Short id generator\n\nWebsite\n\n- [x] Main functions\n\t- [x] Shorten link\n\t\t- [x] URL Validation\n\t- [x] View links\n\t- [x] Delete links\n- [x] Accounts\n\t- [x] Create\n\t- [x] Log in\n\t- [x] Change password\n- [ ] Error/failure display\n\nLink analytics\n\n- [x] Link visited\n- [x] Created at\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrussell98%2Fs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrussell98%2Fs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrussell98%2Fs/lists"}