sitedata / metacpan-explorer

Interactive explorer for the MetaCPAN API

metacpan-explorer

Updating Submodules

This repo includes Bootstrap as a submodule, so after cloning (or pulling) make sure your submodule is up to date:

git submodule init && git submodule update

Docker Development

###Build an image:

docker build -t metacpan/explorer-web-app .

###Run your image:

docker run -p 8080:8080 -d metacpan/explorer-web-app

###View in your browser:

http://localhost:8080/

Dockerless Development

Rebuilding the static files

In the project root run

./build.sh

It will install dependencies via npm and regenerate the static files into the build directory.

The developer vm has everything you need for this.

To run it somewhere else you'll need to make sure you have node.js and npm installed.

Running the development server

You can run node server.js (or npm start) to launch a dev server. See the comments in server.js for additional instructions.

Adding Examples

Log in using the credentials from https://github.com/metacpan/metacpan-credentials/blob/master/github and go to https://gist.github.com/. Create a new public gist with the following file structure:

• endpoint.txt

Contains the path to the API endpoint (e.g. /v1/author/_search)

• body.json

Contains the JSON encoded body of the request. Can be null if the request has no body.

Give the gist a useful description and save. The example should then show up on explorer.metacpan.org