Requeriments
- NodeJS 17
- React 18 =<
Installation
- You need to have a react project 18 version or higher
- npm install hypercurrent-commerce-engine --save
Usage
- Check that you have the latest version installed
- Import the component that you are planning to use for example ProductCarousel
Import {ProductCarousel} from "hypercurrent-commerce-engine"
- You need the product key for see the info related, pass it as a prop to the component
<ProductCarousel apiKey="xxxx"/>
Building & publishing to npm
- To use npm, first ensure you have an npm account on npm.js.
- Then run
npm login
on a terminal. - Update the author and name fields in package.json. The name will define the package name on npm that people can use to install it.
- Run
npm run build
. This will build the app into a dist folder. - Update the version in package.json or by running
npm version <major | minor | patch>
. - Next run
npm publish
to publish up to npm. If you have a paid account you can publish a private package but if it will be public then the flag --access is required.
Now the package is published anyone can install it using npm install <name of package>
.