Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/w3c/echidna
New publication workflow at W3C — main component
https://github.com/w3c/echidna
checker publication spec specification standard validator w3c
Last synced: 3 days ago
JSON representation
New publication workflow at W3C — main component
- Host: GitHub
- URL: https://github.com/w3c/echidna
- Owner: w3c
- License: mit
- Created: 2014-11-05T16:53:27.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2025-01-10T07:14:16.000Z (16 days ago)
- Last Synced: 2025-01-16T17:23:15.017Z (10 days ago)
- Topics: checker, publication, spec, specification, standard, validator, w3c
- Language: HTML
- Homepage: https://labs.w3.org/echidna/
- Size: 4.3 MB
- Stars: 37
- Watchers: 27
- Forks: 33
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/w3c/echidna/actions)
# Echidna
Echidna is the central piece of software taking care of the new publication workflow at [W3C](http://www.w3.org/). The plan is for Echidna and related sub-projects (see below) to automate the publication of new specs under .
## Using Echidna as a spec editor
**If you are a spec editor, you do not need to install Echidna, nor to run it locally.**
Please [see the wiki](https://github.com/w3c/echidna/wiki) for how to use Echidna as a spec editor.
## Hacking Echidna as a developer
### Installation
To run Echidna, you need to install [Node.js](https://nodejs.org/en/) first.
This will install [npm](https://www.npmjs.com/) at the same time, which is required as well.
Then run the following commands with your favorite terminal:
```bash
git clone https://github.com/w3c/echidna.git
cd echidna
cp config.js.example config.js
npm install
```
### Running it locally
*Note: local setup of the full system is not supported currently due to dependency on W3C's DB and IPP system, but having mock services that emulate these pieces is our short-term goal.*
In your terminal, run the following:
```bash
npm start [-- STAGING_PATH [HTTP_LOCATION [PORT [RESULT_PATH]]]]
```
You may use the optional defined below:
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](https://github.com/w3c/specberus).
(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.
Alternatively, you can use the configuration file `config.js`.
Once the server is started, you can throw publication requests at it through a `curl`/`POST` request to its endpoint, , or using the web-based testbed (described below).
You can also use a simple web client to send and monitor those requests, at .
For more information, please refer to [DEVELOPMENT.md](./DEVELOPMENT.md).
### Testing Echidna
This section describes how to run Echidna's test suite to make sure that the project itself is working properly over time. Note that the test suite is not intended to test actual documents.
#### Running the unit test suite
You can run the test suite with the following command line:
```bash
npm test
```
#### Using test documents
For testing purposes, we are using a local web server.
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.
You can launch this test server separately by using:
```bash
npm run testserver
```
When the test server is running, the testbed with all drafts will be available in .
## Feedback and contributions
Please refer to our [contribution reference](https://github.com/w3c/echidna/blob/master/CONTRIBUTING.md) to learn how to contact us, give feedback, or actively contribute to this project.