README.mdx

name	menu
Start Here	Getting Started

Repo: https://github.com/versionone/component-library

Prerequisite Software

Please ensure you have the following installed:

1. yarn@^1.3.2 ^{yarn -v to check}
2. nodejs ^10.0.0 ^{node -v to check, run multiple versions of node via nvm (windows, OSX/Linux)}
3. git
4. VS Code MDX extension (if using VS Code)
5. Sublime MDX extension (if using Sublime Text)

Running Locally

Clone the repo and cd into the repo's directory.

1. yarn && yarn bootstrap
2. yarn start
3. Navigate to http://localhost:3000

If new to the code base, please fully read the recommended reading either locally or on the deployed site before beginning.

Recommended Reading

• Contributing Content
• Developer Guide
• Implement Components
• Document Components

Linking

In some cases we need to enhance the component library and receive quick feedback of the changes in a consuming applicaiton like VersionOne or Continuum.

Working locally with VersionOne (Core)

Here is a small snippet that can be added to your ~/.bash_profile that provides aliases for linking the component library:

DEV_HOME="C:/development"
CORE_DIR="$DEV_HOME/core"
CL_DIR="$DEV_HOME/component-library"

function link() {
    cd "$CL_DIR/packages/components"
    yarn link
    cd "$CORE_DIR/VersionOne.Web"
    yarn link "@versionone/components"
    cd $CL_DIR
    yarn build
    cd $CORE_DIR
    ./gulp watch
}

function buildLink() {
    cd $CL_DIR
    yarn build
    cd $CORE_DIR
    ./gulp watch
}

alias blink="buildLink"
alias link="link"