Code Monkey home page Code Monkey logo

node-yourls's Introduction

node-yourls - Yourls API for nodejs

This module provides hooks into the Yourls API for Nodejs. For more information about Yourls and what it can do, visit their API docs.

Note

YOURLS is a small set of PHP scripts that will allow you to run your own URL shortening service (a la TinyURL). You can make it private or public, you can pick custom keyword URLs. This means you will need the URL of your, or someone else's, YOURLS installation as well as an API Signature token for that install.

Works over both http and https.

Installation

with Node.js

yourls.js is available on NPM

You can install it with the following command:

npm install yourls

Usage

var Yourls = require('./node-yourls/yourls');

var yourls_url = 'ph.ly';
var yourls_api = '1a40d1e654';

var yourls = new Yourls(yourls_url, yourls_api);

yourls.shorten('https://github.com/gabrielpreston/node-yourls', function(error, result) {
	if (error) {
		throw error;
	}
	console.log(result);
});

Tests

To run tests type npm test

Yourls Features

  • shorten
  • vanity
  • expand
  • urlstats
  • stats
  • dbstats

node-yourls's People

Contributors

gabrielpreston avatar peterwilli avatar robman87 avatar

Watchers

 avatar  avatar

Forkers

karl0ss

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.