Poseidon - web publishing for everyone.

The core Poseidon package documentation

Install

npm install

Build

The build system is based on gulp.js.

Test

The following command will run tests within the test folder using mocha.

gulp test

A coverage report will be available, thanks to istanbul in the folder coverage/

Running Poseidon

Instructions for running Poseidon in both local and production environments

Contributing to Poseidon

Want to help? Pull requests are always welcome, and we're always looking for more contributors: development, design, documentation. infrastructure... We will find a way to keep you busy and entertained!

Coding standards

• indent with tabs
• indent size is 2
• install editorconfig for your IDE in order to be consistent. The default .editorconfig file is already in the root folder
• double quotes instead of single ones

TODO

• Core documentation
• Source comments with jsdoc

Next steps (implementation)

• finish tests
• start developing the logger module
• travis integration with github project site
• start using tracker