Getting Started
Thanks for taking your time to visit this section of the Kunyora documentation. This section will help you get started with installing and setting up the Kunyora environment on your personal or work computer. If you have already done this, then you can skip ahead to the Quick tutorial section. This guide also describes how to install react-kunyora which is a binding between ReactJs and Kunyora; other view integrations should be implemented soon.
There are two ways to setup kunyora based on your development environment. Choose the installation type that best suites your needs.
Installation through npm or yarn
For this installation, you need to set up Node. Afterwards, cd into the project directory and enter the following commands.
#For use in a Javasript non-native linked environment
npm install --save-exact kunyora@0.1.1
# or with yarn
yarn add kunyora@0.1.1 --exact
If you are building a single page application, and you have ReactJs or React Native set up as your development environment, you would want to setup react-Kunyora. To set up react-kunyora, cd into the project directory and enter the following commands.
#For use with reactJs
npm install --save-exact react-kunyora@0.1.0
#or with yarn
yarn add react-kunyora@0.1.0 --exact
Installation using cdn links
If you are not building a single page application, you can use Kunyora from the unpkg CDN. Kunyora would be available in your browser as window.kunyoraClient. Add the script below to your html template. To load a specific version of kunyora, Just replace 0.1.1 with the version number.
<script crossorigin src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script crossorigin src="https://unpkg.com/kunyora@0.1.1/dist/kunyora.min.js"></script>
What's Next?
Congratulations, you have successfully installed kunyora. What follows are getting acquinted with the rudiments of the library. If you are curious to learn more about the library then check out the Quick tutorial section.