https://github.com/bootnodedev/db-ui-toolkit

dAppBooster common UI components
https://github.com/bootnodedev/db-ui-toolkit

blockchain ethereum styled-components ui ui-components uikit web3

Last synced: 20 days ago
JSON representation

dAppBooster common UI components

• Host: GitHub
• URL: https://github.com/bootnodedev/db-ui-toolkit
• Owner: BootNodeDev
• License: mit
• Created: 2024-05-27T20:30:30.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-09-05T15:10:05.000Z (2 months ago)
• Last Synced: 2024-10-14T16:37:47.818Z (about 1 month ago)
• Topics: blockchain, ethereum, styled-components, ui, ui-components, uikit, web3
• Language: TypeScript
• Homepage: https://dappbooster.dev
• Size: 988 KB
• Stars: 2
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dAppBooster UI Toolkit

![Static Badge](https://img.shields.io/badge/db-UIToolkit-green?style=flat&color=%238b46a4)

![GitHub package.json version](https://img.shields.io/github/package-json/v/BootNodeDev/db-ui-toolkit?style=flat&color=%238b46a4) ![GitHub top language](https://img.shields.io/github/languages/top/bootnodedev/db-ui-toolkit) ![GitHub License](https://img.shields.io/github/license/bootnodedev/db-ui-toolkit)

[dAppBooster](https://github.com/BootNodeDev/dAppBooster) common UI components

## Installation

- Clone the repo following the usual steps:

```bash

git clone [email protected]:BootNodeDev/db-ui-toolkit.git

```

- Install

```bash

nvm use

pnpm i

```

## Development

- We use [tsup](https://tsup.egoist.dev/) to bundle the components.

- Clone and install `dAppBoosterLandingPage` https://github.com/BootNodeDev/dAppBoosterLandingPage (this version uses all the components from `db-ui-toolkit`)

For example:

```bash

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`:

```bash

pnpm remove db-ui-toolkit

```

- Install your local copy of `db-ui-toolkit` on `dAppBoosterLandingPage` (i.e.: `pnpm i /users/yourusername/db-ui-toolkit`)

```bash

pnpm i 

```

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](https://semver.org/) in `package.json`

- Run `pnpm build`

- Once everything is stable and ready for release [tag a new version](https://semver.org/) so you don't break everything for everyone.

- Finally, run `npm publish` to deploy your changes to NPM.