1.0.4 • Published 4 months ago
revenium-storefront-ui2 v1.0.4
Requeriments
- NodeJS 20
- React 18
Installation
- npm install revenium-storefront-ui2 --save
Usage
- Check that you have the latest version installed
- Import the component that you are planning to use for example ProductCarousel
Import { StoreFrontPage } from "revenium-storefront-ui2"
- You need the product key for see the info related, pass it as a prop to the component graphqlUrl?: string, apiKey?: string,
For Full Store
<StoreFrontPage apiKey="xxxx" graphqlUrl='xxxx'/>
For Payment Subscriptions
< SubscribeModule
product = {{Product}}
apiKey= 'string'
apiUrl = 'string'
userEmail = 'string' />
## Building & publishing to npm
1. To use npm, first ensure you have an npm account on [npm.js](https://www.npmjs.com/).
2. Then run `npm login` on a terminal.
3. 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.
4. Run `npm run build`. This will build the app into a dist folder.
5. Update the version in package.json or by running `npm version <major | minor | patch>`.
6.
7. 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>`.