claudioantonio / sunodo

Sunodo monorepo

Sunodo

Sunodo is a framework for developing decentralized applications built on top of Cartesi technology. It helps developers to:

• create applications from templates
• build applications from source to a cartesi machine
• run applications in a local development environment
• test applications running inside a cartesi machine
• deploy applications to a cloud provider
• monitor application already running on a cloud provider
• doctor verify the minimal requirements for the sunodo execution commands

What's inside?

This monorepo (turborepo) includes libraries and applications for the upper part of the architecture diagram below.

Apps and Packages

• cli: a oclif CLI tool for deployment and management of DApps, available at brew install sunodo;
• controller: a web3 application that monitor DApps deployments and launches cartesi nodes;
• docs: a VitePress app with Sunodo documentation, deployed at https://docs.sunodo.io
• web: a next.js app for Sunodo website, deployed at https://sunodo.io
• app: a next.js app for Sunodo dashboard, deployed at https://app.sunodo.io
• machine-emulator-tools: packaging of cartesi machine emulator tools as Docker images;
• sdk: Docker image to help with cartesi build and execution;
• contracts: support smart contracts for node management;
• ui: a stub React component library shared by both web and app applications
• eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

To build all apps and packages, run the following command:

cd sunodo
yarn run build

Develop

To develop all apps and packages, run the following command:

cd sunodo
yarn run dev