db-ui-toolkit
v0.3.10
Published
dAppBooster common UI components
Downloads
17
Maintainers
Readme
dAppBooster UI Toolkit
dAppBooster common UI components
Installation
- Clone the repo following the usual steps:
git clone [email protected]:BootNodeDev/db-ui-toolkit.git
- Install
nvm use
pnpm i
Development
- We use tsup to bundle the components.
- Clone and install
dAppBoosterLandingPage
https://github.com/BootNodeDev/dAppBoosterLandingPage (this version uses all the components fromdb-ui-toolkit
)
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 ofdAppBoosterLandingPage
:
pnpm remove db-ui-toolkit
- Install your local copy of
db-ui-toolkit
ondAppBoosterLandingPage
(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 usingpnpm dev
Deployment
- I 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 by itself in the preview AND in
dAppBooster
. - Update the version in
package.json
. - Run
pnpm build
. - Commit and push your changes, and merge into
main
- 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.