Home
/
Packages
/
bit-portal

bit-portal

A frontend customer support that aggregates information for boost internal processes, and gives access to initiate / manage / inspect them.

Boost Portal

A react frontend for agents to manage customers

Scaffolding Components

You can use plop to create new react components for the portal.

yarn plop

Running

You can run the web app with a mocked backend by running

yarn start

Schema Update Quick Guide

If changes occur in the schema.gql (Portal API), you need may need to perform several updates on the Portal UI.

1) Generate Types files

From the bit-portal directory run

yarn build-types

This will update the auto generated bit-portal/src/__generated__/globalTypes.ts

2) Updating Mutations and Queries on Portal UI

A Query is used to read or fetch values while a Mutation is used to write or post values.

For a given UI screen (such as a form) GQL query/mutation is defined within the file /screens/<screen>/*.gql For example: bit-portal/src/screens/new-pan-request/new-pan-request.screen.gql

Note: There should be a corresponding Query or Mutation defined in the schema.gql file.