electrode-archetype-react-component

Archetype - Electrode Component

Usage no npm install needed!

<script type="module">
  import electrodeArchetypeReactComponent from 'https://cdn.skypack.dev/electrode-archetype-react-component';
</script>

README

Archetype: Electrode React Component

NPM version Dependency Status devDependency Status npm downloads

Electrode flavored react component archetype.

Have a question? Check the FAQ

Installation

You are suppose to start your Electrode component by using our Yeoman generator-electrode.

Electrode team offers a detailed getting started with Electrode Component tutorial. If you want to check out more on our Electrode component, please use the instructions here as a guide.

Usage

The primary interface to the archetype is a list of tasks you can invoke with clap to do your bidding. To see the tasks, simply run:

$ clap

To demo your packages/components, for example, the dev task, go to your demo-app directory and run:

$ clap dev

To test your components, go to your root directory and run:

$ npm run test

To test a single component, go to your specific 'packages/component' directory and run:

$ clap check

Managing Dependencies

The archetypes are split into two parts: <archetype> and <archetype>-dev. Both archetypes need to be in each component and should be included in the package.json's devDependencies.

Check the archetype configs:

If you are enhancing / refactoring this archetype and have locally checked it out, please see DEVELOPMENT.md for our guidelines.

The main check we provide for the archetype itself is:

$ clap archetype:check

Built with :heart: by Team Electrode @WalmartLabs.