Giter Club home page Giter Club logo

wayneshorter's Introduction

WayneShorter Build Status Dependency Status License

WayneShorter, named after the legendary Jazz musician, is a simple URL shortening service modeled after popular services such as goo.gl and bit.ly.

WayneShorter's headlining performance is made possible by the magic of Node.js and MongoDB.


Running Locally

To get WayneShorter running locally for a private performance, simply give him the starting cue:

Clone:

git clone [email protected]:willricketts/WayneShorter.git

Install services:

OS X

brew install mongodb && brew install nodejs

Ubuntu

sudo apt-get install mongodb
sudo add-apt-repository ppa:chris-lea/node.js 
sudo apt-get update
sudo apt-get install nodejs

Install deps:

npm install

Play that jazz:

npm start

By default, WayneShorter runs in the key of port 3000, but if you'd like to run on a different port, simply let him know:

PORT=1337 npm start

Environment Variables

db_user
db_host
db_pass
db

Routes

GET /

Just a splash view of the legendary Wayne Shorter.

POST /shorten

When passed URLencoded form data, WayneShorter creates and returns an 8th note sized link in the following way:

http://shrtr.in/:identifier

Go ahead and give it a good cURL'n!

curl --data "payload=http://google.com" http://shrtr.in/shorten

RESPONSE:

{"payload":"http://google.com","identifier":"NksNRPPW","shortlink":"http://shrtr.in/NksNRPPW"}

GET /:identifier

When accessed, by its short identifier, the newly created shortlink whisks you away in a flurry of notes to the shortlink's destination.

Who the hell is Wayne Shorter?

Only one of the greatest Jazz musicians ever!

wayneshorter's People

Contributors

willricketts avatar

Stargazers

Josh Sherman avatar

Watchers

 avatar Michael Morrissey avatar

wayneshorter's Issues

Front end responsiveness

The splash view could use some love in terms of how it scales to mobile devices. I'm open to any ideas.

Needs more test coverage

I slapped enough tests on WayneShorter to help me sleep at night, but I'd like to see quite a bit more.

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.