Skip to content
CoffeeScript API documentation generation as a service http://coffeedoc.info
CoffeeScript CSS
Find file

README.md

CoffeeDoc.info

Welcome to the Codo documentation server as a service. You'll find me online at http://www.coffeedoc.info.

Development

The app is hosted on nodejitsu and consists of two drones:

The website

This drone is located under the site directory and is a simple Express app that serves existing documentation and enqueues new requests for adding projects to the job queue.

You can start the first drone locally with:

cd website
coffee server

and open it in your browser under http://localhost:8080/

The jobs queue

This drone is located under the queue directory and starts the Kue web interface for monitoring the jobs queue and waits for working the incoming jobs off.

You can start the second drone locally with:

cd queue
coffee server

and open it in your browser under http://localhost:3000/

Author

License

(The MIT License)

Copyright (c) 2012 Michael Kessler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.