https://github.com/apicurio/apicurio-studio-react-poc

React PoC for apicurio studio
https://github.com/apicurio/apicurio-studio-react-poc

Last synced: 2 months ago
JSON representation

React PoC for apicurio studio

• Host: GitHub
• URL: https://github.com/apicurio/apicurio-studio-react-poc
• Owner: Apicurio
• License: apache-2.0
• Created: 2019-03-15T14:06:54.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T03:51:37.000Z (about 2 years ago)
• Last Synced: 2024-04-16T05:13:06.580Z (9 months ago)
• Language: TypeScript
• Size: 7.78 MB
• Stars: 3
• Watchers: 9
• Forks: 9
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Apicurio React PoC

Apicurio React based Single Page Application based of Patternfly 4

## Requirements

This project requires node version 10.x.x and npm version 6.x.x.  It also uses the yarn package manager (version 1.13.0 or higher).  Prior to building this project make sure you have these applications installed.  After installing node and npm you can install yarn globally by typing 

`npm install yarn -g'

## Development Scripts

Install development/build dependencies

`yarn`

Start the development server

`yarn start:studio`

Run a full build

`yarn build`

Run the test suite

`yarn test`

Run the linter

`yarn lint`

Launch a tool to inspect the bundle size

`yarn bundle-profile:analyze`

## Configurations

* [TypeScript Config](./tsconfig.json)

* [Webpack Config](./webpack.common.js)

* [Jest Config](./jest.config.js)

## Code Quality Tools

* For accessibility compliance, we use [react-axe](https://github.com/dequelabs/react-axe)

* To keep our bundle size in check, we use [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)

* To keep our code formatting in check, we use [prettier](https://github.com/prettier/prettier)

* To keep our code logic and test coverage in check, we use [jest](https://github.com/facebook/jest)