Quick Start Guide
- Last updated on June 2, 2021 at 5:14 AM
Step 1 - Prerequisites
To begin make sure you have registered an account with Elevio.
You will need to have Node.js installed on your computer. We recommend using the latest version of Node.js.
Step 2 - Get the starter template
Next, copy from the JavaScript starter repository:
https://github.com/dixahq/kb-javascript-starter
Alternatively you can copy from the TypeScript starter repository:
https://github.com/dixahq/kb-typescript-starter
To download a copy of the repository, simply click on the Code button then choose 'Download Zip'.
Once downloaded to your device, unzip the file.
Of course, you can also choose to clone the repository if you choose:
git clone git@github.com:dixahq/kb-javascript-starter.git
Step 3 - Open your editor
Open the extracted folder in your code editor of choice.
You may use any text editor or integrated development environment 'IDE' you wish. We recommend Visual Studio Code which is open source, has excellent intellisense prompting, and is free to use.
Important: Within your IDE, open the
settings.jsonfile from the root and fill in your account ID. You can find your account ID on your account page: https://app.elev.io/account
There are many options you can fill into settings.json, see the Client Settings API reference documents for more information.
Step 4 - Install dependencies
Next, install the required JavaScript modules by opening a terminal and running:
yarn# ornpm i
This will install everything you need to start developing and deploying your KB.
Step 5 - Get to work!
To start working on your KB, in your terminal run:
yarn start# ornpm run start
Open your web browser and visit http://localhost:4000. You should see a basic home page with a list of your categories, and any articles nested within those categories.
If you see our documentation instead of your own, be sure to follow step 3 correctly, and update your settings file to use your account ID. Be sure to stop the yarn / npm process and restart it.
As a test, open the file src/pages/home.js and change something like the heading, and save your changes. The changes you make should occur automatically in your browser shortly after you save your changes.