-
Download and install NodeJS. Verify that
node
andnpm
are installed correctly by typingnode -v # Version 10.16.3 (or newer) npm -v # version 6.13.2 (or newer)
-
Download and install Yarn. Verify
yarn
installation by typingyarn -v # version 1.22.4 (or newer)
In the project top directory. Type yarn install
to install external dependencies required by the project. This command must be run when you try to build the project for the first time.
# Install external dependencies (required for the first time)
yarn install
# Start the app on a local server
yarn serve
After typing yarn serve
, use your browser to open localhost:8080
(or whatever port number used by yarn serve
).
yarn build # to build for production
yarn docs:build # to build the documentation
yarn lint # to run linter program
The docs
subdirectory is reserved for documentation files built using VuePress.
To view the documentation page:
yarn docs:serve
To build the documentation page:
yarn docs:build # do this AFTER `yarn build`
After a successful document build, you will find a new directory dist/docs
.