@cloud-carbon-footprint/client
v4.2.4
Published
The front-end dashboard for Cloud Carbon Footprint.
Downloads
417
Readme
@cloud-carbon-footprint/client
This package provides the front end dashboard used by Cloud Carbon Footprint plugins and apps.
Installation
Install the package via npm or Yarn:
$ npm install --save @cloud-carbon-footprint/client
or
$ yarn add @cloud-carbon-footprint/client
Development
Running Locally
Please refer to the documentation on how to run the client locally.
Running Locally with Mock Data
Please refer to the documentation on how to run the client locally with mock data.
Building
There are 2 ways to build this package.
- As an application
yarn build:app
usesreact-scripts
to build a production-ready client app- The results are placed in
./build
ci.yml
usesbuild:app
in thebuild-client
step of thebuild
job
- As a library
yarn build
usestsc
to transpile the source and create type definitions- The results are placed in
./dist
ci.yml
usesyarn build
in thebuild packages
step of therelease
job
Documentation
License
© 2021 Thoughtworks, Inc.