Skip to content

BootNodeDev/db-ui-toolkit

Repository files navigation

dAppBooster UI Toolkit

Static Badge GitHub package.json version GitHub top language GitHub License

dAppBooster common UI components

Installation

  • Clone the repo following the usual steps:
git clone git@github.com:BootNodeDev/db-ui-toolkit.git
  • Install
nvm use

pnpm i

Development

For example:

git clone https://github.com/BootNodeDev/dAppBoosterLandingPage dAppBoosterWeb3ToolkitTest

cd dAppBoosterUIToolkitTest

nvm use

cp .env.example .env.local

pnpm i
  • Remove db-ui-toolkit from your local copy of dAppBoosterLandingPage:
pnpm remove db-ui-toolkit
  • Install your local copy of db-ui-toolkit on dAppBoosterLandingPage (i.e.: pnpm i /users/yourusername/db-ui-toolkit)
pnpm i <path_to_where_db-ui-toolkit_is>

Now you can run dAppBoosterLandingPage locally using pnpm dev and it'll use your local build of db-ui-toolkit.


You can try the following workflow:

  • One console running dAppBoosterLandingPage (pnpm dev will open it on http://localhost:5173/)
  • A second one for watching dAppBooster UI Toolkit's changes, also using pnpm dev

Development / Deployment

  • We suggest working in a branch different to main for this, i.e.: feat/new-feature
  • Make any changes you want.
  • Test your changes. Be thorough. Make sure that everything works in dAppBooster
  • Commit, push, create a PR, merge into main
  • Checkout main and pull the changes.
  • Update the version in package.json
  • Run pnpm build
  • Once everything is stable and ready for release tag a new version so you don't break everything for everyone.
  • Finally, run npm publish to deploy your changes to NPM.