This repo contains the source code for the @feather-ai/feather-web-components
package used to show model UIs in the feather web environments.
To install this package:
- Authenticate to GitHub Packages by following these instructions.
- Create an
.npmrc
file in the root of your project directory which includes the following line:
@feather-ai:registry=https://npm.pkg.github.com
- Add
@feather-ai/feather-web-components
as a dependency to yourpackage.json
file. - Run
npm i
to install the package.
You may now use the package as required.
Coming soon
This repo uses webpack 5 with Babel 7 to compile the React source code located in src/
into bundled ES5 JS and CSS in dist/
. The contents of dist
are used to create an npm
package for use in other repos.
To build a new version of the package (without publishing):
npm i
npm run build
npm pack
Running npm pack
will generate a new .tar.gz
package locally which can be added to any other repo with npm install <file location>
. This can be used for testing before publishing a new version.
Coming soon
This repo also uses Gatsby.js and Storybook to provide live development previews of the components for testing purposes.
To start the development server:
npm i
npm run start
To launch Storybook:
npm i
npm run storybook