Skip to content

simbafs/aurl

Repository files navigation

AURL

AURL

I am developing version 2. You can join me through PR.

AURL

URL shortener written in Node.js
Demo (https://aurl.simba-fs.dev)

Start with Docker

see https://github.com/simba-fs/aurl-docker-deploy

Installation

Download the project.

  • With git
     git clone --depth 1 https://github.com/simba-fs/aurl.git
     cd aurl
     npm i 
  • Without git
     wget https://github.com/simba-fs/aurl/archive/master.zip
     unzip master.sip
     cd aurl
     npm i 

config file

AURL has a preset config (config/default.json), the only thing you need to do is starting a localhost mongodb server (port 27017). To customize your own config, edit your own config/local.json. Examp le is placed in config/default.json.

Google Analytics

GA is available in AURL. To enable it, modify other.GAid in config/local.json.

hCaptcah

You can enable hCaptcha by editing other.hcaptcha in config.local.json. Once enabled, a captcha section will insert in the index page below URL input.

Start the server

npm start

API v1

method path params
GET /code code
GET /url url
POST /create url

TODO

  • Browser addons
  • Improve log
  • Click to copy (finish)
  • add ip record (finish)