Git Product home page Git Product logo

echidna's Introduction

Build Status Dependency Status devDependency Status

Echidna

Echidna is the central piece of software taking care of the new publication workflow at W3C. The plan is for Echidna and related sub-projects (see below) to automatise the publication of new specs under http://www.w3.org/TR/.

Dependencies

OS-level dependencies

npm dependencies

These will be resolved automatically by simply running npm install on the directory of the project.

How to get it up and running

$ git clone [email protected]:w3c/echidna.git
$ cd echidna
$ cp config.js.example config.js
$ npm install
$ npm start

Then simply open http://localhost:3000 on your web browser and start throwing publication requests at it.

Syntax and command-line parameters

(with npm >= 2)

$ npm start [-- STAGING_PATH [HTTP_BASE_URI [PORT [RESULT_PATH]]]]

Meaning of positional parameters:

  1. STAGING_PATH: path in the local filesystem where documents will be downloaded; staged. (Default /var/www/html/trstaging/.)
  2. HTTP_LOCATION: HTTP endpoint for Specberus and the Third-party checker. (Default http://localhost/trstaging/.)
  3. PORT: where Echidna will be listening for publication requests. (Default 3000.)
  4. RESULT_PATH: local path where Echidna will dump the results of publication requests in JSON format.

Examples:

$ npm start -- /home/nick/public_html/staging/ http://localhost/~nick/staging/ 80
$ npm start -- ../tmp/echidna-files/

Automated testing

Command line script

Type this to launch mocha and its associated tests:

$ npm test

Web-based testbed

For testing purposes, we are using an internal web server by default at http://localhost:3001. The test server simulates some of the W3C services, such as the CSS and HTML validators, or the token authorization checker. It also serves a set of sample drafts.

It will get started and stopped automatically when launching mocha.

One may launch this test server separately by using:

$ npm run testserver

When the test server is running, the testbed with all drafts will be available in http://localhost:3001/.

Sub-projects, and related tools

Feedback and contributions

Please refer to our contribution reference to learn how to contact us, give feedback, or actively contribute to this project.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.