https://github.com/simbafs/aurl
URL shortener written in nodejs.
https://github.com/simbafs/aurl
bootstrap4 ckcsc docker expressjs node node-js node-js-express nodejs nodejs-server url-shortener
Last synced: 6 days ago
JSON representation
URL shortener written in nodejs.
- Host: GitHub
- URL: https://github.com/simbafs/aurl
- Owner: simbafs
- License: other
- Created: 2019-11-17T13:29:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-26T05:59:58.000Z (over 1 year ago)
- Last Synced: 2024-06-26T07:11:05.170Z (over 1 year ago)
- Topics: bootstrap4, ckcsc, docker, expressjs, node, node-js, node-js-express, nodejs, nodejs-server, url-shortener
- Language: EJS
- Homepage: https://url.ckcsc.net
- Size: 17.1 MB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
AURL
> I am developing [version 2](https://github.com/simba-fs/aurl/tree/v2). You can join me through PR.
# AURL
URL shortener written in Node.js
[Demo (https://aurl.simba-fs.dev)](https://aurl.simba-fs.dev)
## Start with Docker
see [https://github.com/simba-fs/aurl-docker-deploy](https://github.com/simba-fs/aurl-docker-deploy)
## Installation
### Download the project.
- With git
```BASH
git clone --depth 1 https://github.com/simba-fs/aurl.git
cd aurl
npm i
```
- Without git
```BASH
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
```bash
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)~~