youngkidwarrior/govrn-monorepo

Govrn Monorepo

Our monorepo uses Nx as a build system and for scaffolding.

• Quick Start.
• Monorepo Structure
  • Apps
  • Libraries
• Understand Project Structure
• Furthermore

Quick Start.

• yarn install
• yarn nx run protocol-api:serve to start GraphQL server, if required.
• Check each project's README for more commands.

Monorepo Structure

Each app or lib has its own readme that explains the scoped purpose & required .env variables to operates. You have to create a .env file in each module root and provide the required variables mentioned in its README.

Apps

• Contract Sync Job
• Govrn Contract
• Govrn Contract Subgraph
• Linear Sync Job
• Protocol API
• Protocol Frontend
• Twitter Contribution Job

Libraries

• Govrn Contract Client
• Govrn Subgraph Client
• Protocol Client
• Protocol UI

Understand Project Structure

Run yarn nx graph to see a diagram of the dependencies of the project.

Furthermore

Chat with us on Discord. Follow on Twitter