Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tom-weatherhead/teapot-server

An HTTP teapot server
https://github.com/tom-weatherhead/teapot-server

Last synced: about 8 hours ago
JSON representation

An HTTP teapot server

Awesome Lists containing this project

README

        

# teapot-server

[![build status](https://secure.travis-ci.org/tom-weatherhead/teapot-server.svg)](http://travis-ci.org/tom-weatherhead/teapot-server) [![downloads](https://img.shields.io/npm/dt/teapot-server.svg)](https://www.npmjs.com/package/teapot-server)

An HTTP teapot server

Git installation instructions:

$ git clone https://github.com/tom-weatherhead/teapot-server.git
$ cd teapot-server
$ npm install -g grunt
$ npm install
$ grunt

Note: The command "grunt" runs lint, unit tests, and security tests.

npm Installation Instructions:

$ npm install [--save] teapot-server

To test the sample driver (server.js) of the Web server component (app.js) :

$ npm start

Then browse to http://localhost:3000 to access the main page.

An HTTP GET of http://localhost:3000/teapot will receive a response with HTTP status code 418: I'm a teapot.

The port on which the server listens can be changed in config.json ; it defaults to port 3000.

See https://en.wikipedia.org/wiki/Hyper_Text_Coffee_Pot_Control_Protocol

See also http://www.rfc-base.org/rfc-2324.html