Components used in VersionOne and Continuum
Branch: next
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build S-67433 more tests Feb 14, 2019
cypress S-67418 Fix cypress test issues Feb 15, 2019
docs S-67419 content updates to icon readme files Feb 14, 2019
packages S-67418 Fix cypress test issues Feb 15, 2019
scripts Fix publishing of docs preview Feb 16, 2019
.dockerignore S-67479 do not copy generated icons to docker containers Feb 14, 2019
.editorconfig Initial skeleton- format via prettier- eslint via `yarn lint`- test (… Nov 14, 2018
.eslintignore Initial skeleton- format via prettier- eslint via `yarn lint`- test (… Nov 14, 2018
.eslintrc.json do not require default export Dec 17, 2018
.gitattributes Initial skeleton- format via prettier- eslint via `yarn lint`- test (… Nov 14, 2018
.gitignore S-67419 Move Base to not be exported from icons package- README requi… Feb 14, 2019
.nvmrc Configure netlify without needing to do so via the netlify UI Dec 17, 2018
.prettierrc Initial skeleton- format via prettier- eslint via `yarn lint`- test (… Nov 14, 2018
.travis.yml Lint as js script Feb 16, 2019
LICENSE.md License updates Dec 19, 2018
README.mdx S-67479 provide start/stop scripts that simply run site in docker Feb 14, 2019
babel.config.js S-67421 install deps required by components Feb 6, 2019
cypress.json Run test in parallel to reduce build time Feb 14, 2019
doczrc.js Linting (non failure of build) Feb 15, 2019
lerna.json v0.0.4 Dec 14, 2018
netlify.toml S-67479 Provide better scripts to run install, test, lint, independently Feb 14, 2019
package.json use node for build scripts instead of bashBetter reporting back to Gi… Feb 16, 2019
yarn.lock use node for build scripts instead of bashBetter reporting back to Gi… Feb 16, 2019

README.mdx

---
name: Start Here
route: /
menu: Getting Started
---

# 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 <sup>`yarn -v` to check</sup>
2. [nodejs](https://nodejs.org/en/) ^10.0.0 <sup>`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))</sup>
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](getting-started/contributing-content)
- [Developer Guide](getting-started/developer-guide)
- [Implement Components](getting-started/implement-components)
- [Document Components](getting-started/document-components)