apex-react v2.1.3

apex-react

React component library for Apex-Web.

Install

npm install --save apex-react

Usage

Use components in your own project simply by importing like so:

import React, { Component } from 'react'

import { MyComponent } from 'apex-react'

class Example extends Component {
  render () {
    return (
      <MyComponent />
    )
  }
}

Development

Versioning

After committing and merging changes, pull the changes to your master branch and run

npm version <tag> -m "<description>"

where <tag> is the desired package version following semantic versioning. The <description> should be a brief description of the update, i.e. Minor bugfix.

npm version will automatically update your package.json file to reflect the new version, and create a corresponding git tag. To complete the update, push your tags to the origin.

git push origin <tag>

If you make a mistake, you can delete a tag by doing:

git tag -d <tag>

Publishing

When pushing to the npm registry, you should publish with an appropriate distribution tag. For production releases that are published from master you should publish to the main release:

npm publish

For testing a release from a branch, use the beta distribution tag:

npm publish --tag beta

The npm publish command should correctly tag your release with the appropriate version number in your package.json (created in the Versioning section).

Storybook

To view the components in Storybook, run the following in the root directory:

npm run storybook

Some stories are dependent on having a GraphQL server and a valid JWT. Authenticate with your GraphQL server and retrieve the JWT. Create a .env.development file in the root directory and declare two environment variables for your Storybook.

STORYBOOK_GQL_JWT=[your_jwt_without_bearer_text]
STORYBOOK_GQL_URI=[your_gql_endpoint]

License

MIT © crdc/apex