Hosted automated jsdoc API documentation
JavaScript HTML CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
bin
fixtures
lib
test
views
.dockerignore
.gitignore
.travis.yml
LICENSE
README.md
api-server.docker
doc-worker.docker
docker-compose-dev.yml
docker-compose-test.yml
docker-compose.yml
package.json
style.css
web-server.docker

README.md

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.