-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated the README file for this project.
- Loading branch information
Showing
1 changed file
with
52 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,58 @@ | ||
# react-user-feedback | ||
# PatternFly React User Feedback | ||
|
||
An PatternFly extension used to collect user feedback. | ||
This project is a [PatternFly](https://github.com/patternfly/patternfly-react) React based component used to collect user feedback. Examples of how to use this extension are documented on | ||
the PatternFly website under [Extensions](https://www.patternfly.org/v4/extensions/user-feedback) | ||
|
||
To build & run the development server: | ||
* yarn install | ||
* yarn start | ||
## Installing dependencies | ||
This extension uses [yarn](https://yarnpkg.com/) for building and development. You can install the dependencies for this project using the yarn install. | ||
``` | ||
yarn install | ||
``` | ||
## Building the extension | ||
To build the user-feedback extension locally first follow the instructions to install the dependencies. Once that has completed type the following in a terminal: | ||
``` | ||
yarn build | ||
``` | ||
|
||
To run tests: | ||
* yarn test | ||
## Development instructions | ||
|
||
|
||
### Using the development server | ||
The development server will show you the documentation for this product along with working examples. This is what is used for running and developing the feedback extension. | ||
|
||
You can start the development server by typing: | ||
``` | ||
yarn start | ||
``` | ||
|
||
### Running Unit Tests | ||
[Jest](https://jestjs.io) along with [React testing library](https://testing-library.com/docs/react-testing-library/intro/) are used to test the components that make up this extension. | ||
|
||
To run unit tests first you can type: | ||
``` | ||
yarn test | ||
``` | ||
|
||
### Linting | ||
[ESLint](https://eslint.org/) is used to ensure everyone that contributes to this project is following the same best practices, and to statically analyze the code. | ||
|
||
To run the linter: | ||
* yarn lint | ||
``` | ||
yarn lint | ||
``` | ||
|
||
### Accessability | ||
Accessability (a11y) tests are used to make sure the extension is meeting the same a11y guidelines as PatternFly. Running the a11y tests require that the documentation is built and served. | ||
|
||
To build the documentation type the following in a terminal: | ||
``` | ||
yarn build:docs | ||
yarn serve:docs | ||
``` | ||
|
||
In a new terminal window to run the accessibility tests type: | ||
``` | ||
yarn test:a11y | ||
``` | ||
|
||
To build & run the a11y tests: | ||
* yarn build:docs | ||
* yarn serve:docs | ||
* yarn test:a11y in a new terminal window to run our accessibility tests. | ||
* Once the accessibility tests have finished running you can run yarn serve:a11y to locally view the generated report. | ||
Once the accessibility tests have finished running you can run yarn **serve:a11y** to locally view the generated report. |