GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — GitHub - lipp/doclets: Hosted automated jsdoc API documentation

Branches Tags

Open more actions menu

Latest commit

History

486 Commits

Folders and files

Name		Name	Last commit message	Last commit date
assets		assets
bin		bin
fixtures		fixtures
lib		lib
test		test
views		views
.dockerignore		.dockerignore
.gitignore		.gitignore
.travis.yml		.travis.yml
LICENSE		LICENSE
README.md		README.md
api-server.docker		api-server.docker
doc-worker.docker		doc-worker.docker
docker-compose-dev.yml		docker-compose-dev.yml
docker-compose-test.yml		docker-compose-test.yml
docker-compose.yml		docker-compose.yml
package.json		package.json
style.css		style.css
web-server.docker		web-server.docker

Repository files navigation

doclets

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

doclets.io

Resources

Readme

MIT license

Activity

Stars

206 stars

Watchers

3 watching

Forks

12 forks

Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.