Thanks for your interest in contributing to 0xIntuition. We're happy to have you here.
Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.
If you need any help, feel free to reach out to @0xintuition.
This repository is a monorepo.
- We use pnpm and
workspacesfor development. - We use Nx as our build system.
- We use changesets for managing releases.
This repository is structured as follows:
apps
└── portal
packages
├── 1ui
└── api
└── protocol
└── sdk
| Path | Description |
|---|---|
apps/portal |
The Remix application for the playground |
packages/1ui |
Our design system. |
packages/api |
backend interactions |
packages/protocol |
protocol SDK |
packages/sdk |
high level logic that combines both on-chain and off-chain |
Please read the corresponding CONTIBUTING.md file for the app/package you wish to contribute to:
You can fork this repo by clicking the fork button in the top right corner of this page.
git clone https://github.com/0xIntuition/intuition-ts.gitgit checkout -b my-new-branchpnpm installYou can use the pnpm [WORKSPACE]:dev command to start the development process for a workspace.
- To run the
portalweb app:
pnpm portal:dev- To run the
1uistorybook:
pnpm 1ui:storybookThe documentation for this project is located in the docs workspace. You can run the documentation locally by running the following command:
pnpm docsDocumentation is written using MDX. You can find the documentation files in the docs directory.
If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out.
Tests are written using Vitest. You can run all the tests from the root of the repository.
pnpm testPlease ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests.