Skip to content

lipp/doclets

Repository files navigation

doclets

Join the chat at https://gitter.im/lipp/doclets Build Status Coverage Status js-standard-style

Dev setup

$ docker-compose -f docker-compose-dev.yml up

Populate local DB

$ DEV=1 node bin/replay-events.js

Run webserver locally

$ DEV=1 node bin/server.js

To view a doc page, you have to know the repo name (as in `fixtures/events/*/payload.js). e.g. [numbers.js] (http://localhost:8080/lipp/numbers.js)

Unit test setup

$ docker-compose -f docker-compose-test.yml up

Run tests locally

$ TEST=1 npm test

Adding users/repos does not work with the local server :( This is due to GitHub WebHook configuration and GitHub OAuth wich require fix urls.

About

Hosted automated jsdoc API documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published