NameKit contains multiple projects, including NameGuard.
You must clone this respository, and install the dependencies using PNPM before you can run it locally:
git clone https://github.com/namehash/namekit.git
cd namekit
pnpm i
pnpm dev
It's recommended you run pnpm dev
in the root of the repository to start all apps, packages, and internal resources to support local development.
Tests are automatically ran when a new Pull Request is opened. You can run them locally using pnpm test
.
If you're developing locally, you can watch changes and run tests automatically using pnpm test:watch
.
We use changesets to manage our releases.
- Run
pnpm changeset
- Choose the packages you want to release
- Add a summary of the changes
- Commit the file
- Open a Pull Request
- Once the PR is merged, a new or existing
Version Packages
PR will open. - Merge the
Version Packages
PR when you're ready to release a new version (of all packages) to NPM, or wait to merge in other changesets first.
We use Storybook to preview components across our core packages:
@namehash/namekit-react
@namehash/nameguard-react
@namehash/ens-webfont
@namehash/ui
- These components are mostly internal and not intended for public use, but they are used across our packages.