wf-elements v0.0.5

wf-elements

Bugcrowd React component library

WfElements is a set of compoents to show data for Crowd History

• Crowd History Stats
• Crowd History Graph
• Crowd History Table

Contents

• wf-elements
  • Contents
  • Installation
  • Developing
    • Component guidelines
  • Releasing
  • Todos
    • Stories
  • Testing
    • Release History App

Installation

This module is distributed via Github packages.

You will need to configure npm/yarn you use the bugcrowd scoped repository

1. Create a personal access token at https://github.com/settings/tokens
   • Only requires the read:packages scope

2. Add the following to ~.npmrc

   //npm.pkg.github.com/:_authToken=<YOUR_PERSONAL_ACCESS_TOKEN>

3. Install

   npm install  @bugcrowd/wf-elements

Developing

⬆ back to top

Component guidelines

• Components should be simple and easy to read
• Components must not render result in container elements
• Consider whether this component needs to manage its state
• The component must support multiple usages on a page
• The component shouldn't need an id to work
• Any logic that a component needs should be external to the component - within the same file is ok

Releasing

⬆ back to top

Todos

Next:

• add more docs

⬆ back to top

Stories

Stories are co-located with the component.

Testing

Tests are written using React Testing Library and run Jest

Tests are co-located with the component.

⬆ back to top

Release History App

⬆ back to top