@p2olab/pimad-core v0.0.1-alpha15

PiMAd-core

Processindustry-Modular-Automation-description: High level access to automation of modular plants.

prerequisites

Install NPM via Node.js for your operating system (The LTS version should meet our requirements). Check the version of Node.js and NPM on your machine.

# Node.js:
node -v
# NPM
npm -v

Next step is installing the dependencies via NPM.

npm install

Awesome. We are ready to code! You may install an IDE like WebStorm: The many little helpers make programming more pleasant.

testing & linting

Understanding the use of Test-Driven-Development and linters please feel free to consult us and may have a look at the Contribution section.

# run tests + code coverage report
npm run test
# run linter
npm run lint

Afterwards you will find the web-page based coverage report in the folder coverage. The entry point is coverage/index.html.

build the application

Converting the TypeScript-code into plain JavaScript.

npm run build

run the application

W.I.P. Actually there is no real entry point :poop:

npm run start

documentation

Web-page based documentation will be build via

npm run build-gdocs

Afterwards you will find a folder docs in your project directory. The documentation entry point is docs/index.html.

Coded with :heart: by @cheidelbach