@lrnwebcomponents Monorepo for NPM based element definitions
Welcome to the lrnwebcomponents project!
ELMS:LN produced web components for any project
Notice: You will need to use Node version 6.0 or higher. Verify that you have yarn enabled — if not install yarn globally. These web components are written in ES6 and build routines compile to es5 to encompass more browsers.
$ git clone https://github.com/elmsln/lrnwebcomponents.git $ cd lrnwebcomponents $ yarn global add @wcfactory/cli $ yarn global add polymer-cli $ yarn global add lerna $ yarn global add web-component-analyzer $ yarn install
Cygwin command line is lightly tested, but slower than true Bash environment.
To properly configure git endlines for Windows, run this configuration
bash $ git config --global core.autocrlf true
$ git clone https://github.com/elmsln/lrnwebcomponents.git $ cd lrnwebcomponents $ yarn global add symlink-dir $ yarn global add @wcfactory/cli $ yarn global add polymer-cli $ yarn global add lerna $ yarn global add web-component-analyzer $ yarn install
$ cd elements/ELEMENTNAME $ yarn start
Edit files in
lib/,
src/and
demo/in order to modify the element to contribute back to us via PR.
$ wcf element
$ yarn run rebuild-wcfcache
$ yarn test
$ yarn run build
$ yarn run storybook
$ yarn run build-storybook
$ lerna publish
$ lerna run build --no-bail
buildcommand in all projects in the repo, don't bail if there's an issue
Because this is a monorepo, each web component will need to be independently built in order to actively work on and preview the changes. Every web component has its own Gulp file and Yarn/NPM script.
While still running
yarn startin one terminal window (which runs the local server), you will need to open another terminal window, drill into the directory of the web component you'd like to work on, and execute the
yarn run devcommand. This command will use gulp tasks to watch the files within that web component directory and will automatically re-run the build command and refresh the browser when you make changes to the web component.
Run
wcf elementto make a new element. Go to the new element following the directions generated at the end of the element's creation. To work on the new-element run
yarn startfrom it's directory. If you are pulling in another element to use, run
yarn add projectname --save.
$ cd /Sites/lrnwebcomponents $ yarn startSHIFT + CTRL + T to open a new tab in Terminal
$ cd elements your-card # or any other web component $ yarn run dev
Make a change to the web component and save. The gulpfile will handle transpiling the element down to ES5 and will bring in the HTML and Sass into the template in the web component.
To test all lrnwebcomponents, run
yarn testfrom the root of the repo. If you only want to test the web component you're working on:
$ cd elements/your-card $ yarn test
Also, if your tests are failing and you want access to a live browser to investigate why, the following flag will keep the browser open.
$ yarn test -- -p
Then open the URL that will be printed in the terminal. It looks something like this:
http://localhost:8081/components/@@lrnwebcomponents/lrnwebcomponents/generated-index.html?cli_browser_id=0.
We've added Storybook to lrnwebcomponents as a way to preview our web components as they are being developed. We'll also use Storybook to export a static site that will be the demo site for lrnwebcomponents.
To run storybook
$ yarn run storybook
This will start a web server on port 9001. Navigate in your browser to
http://localhost:9001to see Storybook in action. Storybook will watch for file changes and reload the browser automatically for you. This is a little slow at the moment, but we'll look into speeding this up.
To export the storybook static site
$ yarn run build-storybook
This places a build of the storybook site in the .storybook_out directory.
For any web component that has a third-party dependency you will need to update the
/.storybook/webpack.config.jsfile. You will need to create an alias for your depedency.
For example:
"../../whatwg-fetch/fetch.js": path.join( // this is the third-party dependency in the lrnwebcomponents __dirname, "../node_modules/whatwg-fetch/fetch.js" // this is where it lives in node_modules )