README.md

Slope Engine

Engine for the Slope route modelisation

Website — Documentation — License

• 📥 Getting started
• 🔬 API
• 💻 Development
  • Installation
  • Test the package
  • Build the package
• 📜 Credits
• 🔐 License

📥 Getting started

Install this package and add it to your project :

npm i slope-engine     # Using NPM
yarn add slope-engine  # Using Yarn

🔬 API

TODO

💻 Development

Thank you for being interested in Slope Engine's development! Please follow these instructions in order to get started.

Installation

You must have a recent Node.js version installed (recommended: v12+) and Git in any form : CLI, UI, GitHub...

Clone the repository on your local machine :

git clone https://github.com/exybore/slope-engine.git  # Via HTTP
git clone git@github.com:exybore/slope-engine          # Via SSH

Install the required dependencies to build and test Slope Engine :

npm i         # Using NPM
yarn install  # Using Yarn

Test the package

The Jest framework powers tests, which are stored in individual files inside the tests folder.

Run tests on the package using the test script :

npm run test  # Using NPM
yarn test     # Using Yarn

Build the package

The src folder contains all the main code, and the entry point is the index.js file. A build system powered by rollup in order to minify code and merge imports into a single file.

Build the package using the build script :

npm run build  # Using NPM
yarn build     # Using Yarn

📜 Credits

• Maintainer: exybore

🔐 License

GNU GPL v3. See license