This monorepo contains:
- Reusable React components deployed as npm package
- Demo React App using these components
git clone https://github.com/RBFLabs/agoric-react-components.git
cd agoric-react-components
- Run the Demo App - instructions here
- For components reference go here
yarn build
- Build all packagesyarn dev
- Run all packages locallyyarn lint
- Lint all packagesyarn changeset
- Generate a changesetyarn clean
- Clean up allnode_modules
anddist
folders (runs each package's clean script)
This repo uses Changesets to manage versions, create changelogs, and publish to npm. It's preconfigured so you can start publishing packages immediatley.
You'll need to create an NPM_TOKEN
and GITHUB_TOKEN
and add it to your GitHub repository settings to enable access to npm. It's also worth installing the Changesets bot on your repository.
To generate your changelog, run yarn changeset
locally:
- Which packages would you like to include? – This shows which packages and changed and which have remained the same. By default, no packages are included. Press
space
to select the packages you want to include in thechangeset
. - Which packages should have a major bump? – Press
space
to select the packages you want to bump versions for. - If doing the first major version, confirm you want to release.
- Write a summary for the changes.
- Confirm the changeset looks as expected.
- A new Markdown file will be created in the
changeset
folder with the summary and a list of the packages included.
When you push your code to GitHub, the GitHub Action will run the release
script defined in the root package.json
:
turbo run build --filter=docs^... && changeset publish
Turborepo runs the build
script for all publishable packages (excluding docs) and publishes the packages to npm. By default, this example includes acme
as the npm organization. To change this, do the following:
- Rename folders in
packages/*
to replaceacme
with your desired scope - Search and replace
acme
with your desired scope - Re-run
yarn install
To publish packages to a private npm organization scope, remove the following from each of the package.json
's
- "publishConfig": {
- "access": "public"
- },
If you are about to contribute to this project for the very first time, make sure to read the contributing guidelines. You will make it easier for both yourself and maintainers of this project.