Installing the developer portal
Prerequisites
Before installing the the developer portal:
- Install
yarn
. It works across all the major operating systems. - Know how to run the commands from the CLI (for example,
yarn install
). For Windows, we recommend using Git Bash. - Learn common git techniques (creating a branch, committing, and in our examples, opening a pull request on GitHub.)
- Get familiar with Markdown.
We recommend using Visual Studio Code to manage your files.
Install the Portal
- Create a repository based on the template repository.
The template includes a follow-along tutorial for you to familiarize with the features and functionality.
- Install the project.
yarn install
Run the development server
yarn start
Preview your files on the local server displayed in the terminal.
Troubleshooting installation
If an error occurs during installation, delete the yarn.lock
file, and then try to install it again.
rm yarn.lock
yarn install
If the installation problem persists, please contact us.