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

Components used in VersionOne and Continuum
https://github.com/versionone/component-library

components documentation-site gatsby javascript react react-components versionone

Last synced: 2 months ago
JSON representation

Components used in VersionOne and Continuum

• Host: GitHub
• URL: https://github.com/versionone/component-library
• Owner: versionone
• License: bsd-3-clause
• Created: 2018-11-20T15:37:29.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-13T18:51:27.000Z (over 1 year ago)
• Last Synced: 2024-04-29T10:07:14.780Z (9 months ago)
• Topics: components, documentation-site, gatsby, javascript, react, react-components, versionone
• Language: JavaScript
• Homepage: https://versionone-components.netlify.com/
• Size: 4.85 MB
• Stars: 2
• Watchers: 30
• Forks: 2
• Open Issues: 30
• Metadata Files:
  • Readme: README.mdx
  • License: LICENSE.md

Awesome Lists containing this project

README

        
---

name: Start Here

menu: Getting Started

---

Repo: [https://github.com/versionone/component-library](https://github.com/versionone/component-library)

## Prerequisite Software

Please ensure you have the following installed:

1. [yarn](https://yarnpkg.com/en/)@^1.3.2 `yarn -v` to check

2. [nodejs](https://nodejs.org/en/) ^10.0.0 `node -v` to check, run multiple versions of node via nvm ([windows](https://github.com/coreybutler/nvm-windows), [OSX/Linux](https://github.com/creationix/nvm))

3. [git](https://git-scm.com/)

4. [VS Code MDX extension](https://marketplace.visualstudio.com/items?itemName=silvenon.mdx) (if using VS Code)

5. [Sublime MDX extension](https://github.com/jonsuh/mdx-sublime) (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](http://localhost:3000)

> If new to the code base, please fully read the recommended reading either [locally](http://localhost:3000) or on the deployed site before beginning.

## Recommended Reading

- [Contributing Content](docs/getting-started/contributing-content.mdx)

- [Developer Guide](docs/getting-started/developer-guide.mdx)

- [Implement Components](docs/getting-started/implement-components.mdx)

- [Document Components](docs/getting-started/document-components.mdx)

## 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"

```