https://github.com/0xintuition/intuition-ts
Intuition Typescript monorepo.
https://github.com/0xintuition/intuition-ts
Last synced: 12 months ago
JSON representation
Intuition Typescript monorepo.
- Host: GitHub
- URL: https://github.com/0xintuition/intuition-ts
- Owner: 0xIntuition
- License: mit
- Created: 2024-04-24T05:39:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-16T19:03:53.000Z (12 months ago)
- Last Synced: 2025-06-16T20:21:08.735Z (12 months ago)
- Language: TypeScript
- Homepage: https://0xintuition.github.io/intuition-ts/
- Size: 205 MB
- Stars: 29
- Watchers: 5
- Forks: 9
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to the Intuition TypeScript Monorepo
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.
## Monorepo Structure
Our monorepo uses [pnpm](https://pnpm.io/) and [Nx](https://nx.dev/) 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.
### Apps
- [Portal](./apps/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](./apps/data-populator/) is an app for bulk creation of atom data. The Data Populator README contains additional information.
- [Template](./apps/template) is an opionionated template for our core app development stack.
### Packages
- [1ui Component Library](./packages/1ui/) 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](./packages/api/) is the REST API interaction layer of Intuition.
- [graphql](./packages/graphql/) is the SDK for the GraphQL interaction layer of Intuition containing hooks, queries, and other utilities.
- [protocol](./packages/protocol/) is the onchain interactions (ABIs, bytecode) SDK.
- [sdk](./packages/sdk/) contains high level logic that combines both on-chain and off-chain interactions. Coming Soon!
## Getting Started
### Prerequisites
We recommended using [Node.js](https://nodejs.org/) >= 18.0, preferably v20+.
We also recommend using [NPM](https://www.npmjs.com/) >= 9.8.
You can optionally install Nx globally by following their [installation instructions](https://nx.dev/getting-started/installation).
You can also optionally install pnpnm globally by following their [installation instructions](https://pnpm.io/installation).
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
### Environment variables
Please read [Nx's env variable definition guide](https://nx.dev/recipes/tips-n-tricks/define-environment-variables) 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
## Contributing
Please read the [contributing guide](./CONTRIBUTING.md).