{"repo":"vtex/styleguide","free":true,"listed":false,"github":"https://github.com/vtex/styleguide","clone":"git clone https://github.com/vtex/styleguide.git","description":"The VTEX Design System and React component library.","language":"JavaScript","stars":173,"topics":["react","component-library","frontend-components","react-library","react-components","design-system","styleguide","xp-developer","srv-styleguide","vtex"],"license":"GPL-3.0","category":"ui-components","readme_excerpt":"Styleguide VTEX Styleguide React components (Docs) - Usage - Developing - Setup - Running - Developing using npm link - Publishing - Docs Usage For instructions on how to use the Styleguide in your project refer to the page itself: https://vtex.github.io/styleguide/. Developing Setup Running Storybook We use Storybook environment to help us build and test our components in real time. You can edit the Playground file and add the components you are working on, after this run the command below to see your changes in http://localhost:6006/ : If you want to change or add stories, take a look at this guide before. Developing using npm link Run this in this repo: In your project run: Import (case a component in lib): Testing Developing new tests To add tests to a component, just add a test file with the .test.js extension next to the component implementation. Example: We use react-testing-library to test our components. Running tests To run the test use: You can also pass the --watch flag: Publishing --- To post the changelog on Github Release Notes, is required to configure a Personal Token. See more here We use releasy to publish our styleguide. To publish on both npm and render(VTEX IO) with Github Release Notes, execute the command below: Docs To update the docs: Known issues - Your project has to run with webpack = 2. Here's a guide for upgrading Webpack to v2. - VTEX Styleguide is a project built to run on top of either npm or VTEX IO . To make this viable, we currently use tw","default_branch":null,"files":null,"tree":[],"storefront":"/r/vtex","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/vtex/styleguide/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}