Intuition is the trust protocol bringing human trust to trustless systems. We are an ecosystem of technologies composing a universal and permissionless knowledge graph.
We're using a monorepo to organize the development of our ecosystem. Our monorepo will eventually be open to community contributors, but right now we're focusing on scaffolding, architecture, and establishing patterns.
Our monorepo uses pnpm and Nx and is organized into apps and packages. Our apps folder contains our core applications. We'll be expanding our monorepo to include additional apps and our starter templates. Our packages folder contains our utilities and libraries that will eventually be published and available to the community and larger ecosystem.
Each app and package has it's own README with instructions for getting up and running.
- Portal is the first core application in our new monorepo. The Portal README contains additional information and details about how to get started.
- Data Populator is an app for bulk creation of atom data. The Data Populator README contains additional information.
- Template is an opionionated template for our core app development stack.
- 1ui Component Library is the first package in our new monorepo. This is our core component library that also includes a Storybook instance. The 1ui README contains additional information.
- api is the REST API interaction layer of Intuition.
- graphql is the SDK for the GraphQL interaction layer of Intuition containing hooks, queries, and other utilities.
- protocol is the onchain interactions (ABIs, bytecode) SDK.
- sdk contains high level logic that combines both on-chain and off-chain interactions. Coming Soon!
We recommended using Node.js >= 18.0, preferably v20+.
We also recommend using NPM >= 9.8.
You can optionally install Nx globally by following their installation instructions.
You can also optionally install pnpnm globally by following their installation instructions.
Each package will have more detailed instructions, but you should clone the entire monorepo and work from the root:
- Clone the monorepo from the root:
git@github.com:0xIntuition/intuition-ts.git - Follow individual instructions for each app and package
Please read Nx's env variable definition guide to see how we organize our env variables. Each app/package will have the following files that reflects the three configurations we have.
- .env.local
- .env.test
- .env.production
Please read the contributing guide.