https://github.com/vilicvane/biu-link

A simple URL shorter.
https://github.com/vilicvane/biu-link

Last synced: 20 days ago
JSON representation

A simple URL shorter.

• Host: GitHub
• URL: https://github.com/vilicvane/biu-link
• Owner: vilicvane
• Created: 2014-08-10T06:13:14.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-03-04T11:00:18.000Z (almost 10 years ago)
• Last Synced: 2024-11-30T15:41:51.317Z (23 days ago)
• Language: HTML
• Homepage: http://biu.link
• Size: 237 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Biu v0.1

Pronounces "be-yo", the sound that old-fashioned laser gun in films would make. The slash above "i" means the 4th tone of [Pinyin](http://biu.link/pinyin-tones).

It's a simple URL shortener for NodeJS.

As it's designed for private use, considering the links number won't be very large, Biu uses **TEXT FILE** instead of a database to store links. And it will read all links data to memory when starts.

Demo http://biu.link

![biu screenshot](/images/screenshot.png?raw=true)

**Hint**  

Click "shorten it" with meta/ctrl key to ignore existing path and overwrite it.

## Configuration

config.json (the values below are defaults)

```javascript

{

    // the text file that saves links data

    "linksFile": "links.txt",

    // a regex (string form) that tests whether the url is valid

    "urlRegex": "^\\w+:\\S+$",

    

    // a regex (string form) that tests whether the shortened path is valid

    "pathRegex": ".",

    

    // the entrance of this biu

    // change it to something else if you want to use this biu privately

    "entrance": "/",

    // redirect url for path not matching any existing records

    // the path (without leading /) will be added to the value directly

    "redirect": null,

    

    // port to listen, fallbacks to process.env.PORT or 1337

    "port": 1337

}

```

## API

The API URL is the same as the entrance.

E.g. as http://biu.link has it entrance set to "/", the API URL is http://biu.link/; Or if its entrance is "/xxx", the API is then http://biu.link/xxx.

### Method and Formats

Use POST method to invoke the API. Accepted Content-Type includes urlencoded (application/x-www-form-urlencoded) and JSON (application/json). The response is always in JSON.

### Request Parameters

**type** should always be string "add".  

**url** the url to be shortened.  

**path** (optional) custom path.  

**force** (optional) if path is specified, true to ignore and overwrite if it already exists.  

### Response

#### Success

```typescript

{

    path: string

}

```

Here path is not full url, append it to the base url to make it complete.

#### Error

```typescript

{

    error: {

        message: string,

        code: number

    }

}

```