README.md

Cocoon XML Sugar

Sugar for the XML that holds the configuration of a Cocoon.io Project.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You need to have NodeJS and NPM installed in your system.

curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt install -y nodejs

Installing

Clone the repository.

git clone https://github.com/CocoonIO/cocoon-xml-sugar.git

And install its dependencies.

npm install

The transpiled code should be in the out folder.

Running the tests

The tests are found in spec/tests.

npm test

Coding style tests

To inspect the code style of the source code.

npm run inspect-src

To inspect the code style of the tests.

npm run inspect-spec

Deployment

To use this repo as a NPM module in your project follow these instructions.

Install NodeJS and NPM in your system.

curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt install -y nodejs

Install the module from NPM.

npm install cocoon-xml-sugar

And import it in your NodeJS or Web project.

import XMLSugar from "cocoon-xml-sugar";

<script src="cocoon-xml-sugar/index.js"></script>

Built With

• Typescript - Language.
• NPM - Dependency Management.
• Jasmine - Testing Framework.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Imanol Fernandez - Version 1.0.0 - MortimerGoro
• Jorge Domínguez - Version 2.0.0 - BlueSialia

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.