Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.34 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.34 KB

NBS Modernization Frontend

Running

  1. From the apps/modernization-ui directory, execute

    npm install

  2. Then execute to start the application. Default url is http://localhost:3000

    npm run start

Auto Generating Endpoints

The UI code utilizes gql-typescript-generator and graphql-code-generator to auto generate GraphQL API requests.

Workflow:

  1. Update the API .graphqls schema files
  2. Run the following command in the modernization-ui folder while the API is running 
    npm run generate
  3. Use the newly generated methods to make API calls from typescript

Storybook

Storybook is a component library that gives information on how to use the reusable react components like button,checkbox, table and so on. Run storybook locally to see what components are already available.

npm run storybook.

The no lint option is to ensure there aren't any lint errors as of now. This could be an effort going forward.

Containerizing

The frontend application can be packaged as a Docker container by executing the following command from the apps/moderniztion-ui directory

docker build .