Builder DAO.

Builder DAO monorepo.

What's inside?

This turborepo uses Yarn as a package manager. It includes the following packages/apps:

Apps, Packages, Tutorials, and Solana Programs.

apps:
- web: BuilderDAO frontend
  - /learn/<tutorial-name>/<md-file-name>Renders tutorials.
  - /proposal/<proposal-publickey>Renders proposals. (TODO)
packages:
- ui: a stub React component library shared by both web and docs applications
- config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
- tsconfig: tsconfig.jsons used throughout the monorepo
- md-utils: utilities for parsing markdown files
tutorials:
- <tutorial-name>
  - /builderdao.config.js: configuration for the tutorial
  - /content/<md-file>: tutorial content
programs:
- <solana-program-name>: a solana program
  - /src: rust source code for the program
  - /ts: SDK source code
  - /tests/: rust test code for the program
  - /__tests__: typescript tests for the program

Build

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

yarn run build

Develop

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

yarn run dev

How to use?

Quick start for authors.

yarn
yarn build:cli
builderdao --help

How to start a tutorial.

Writing a tutorial

By running yarn install in the root of the project you should have a BuilderDAO CLI available

Initializing tutorial

In order to initialize tutorial run

builderdao tutorial init

You will be prompted with few questions about your tutorial. After you are done you will have a boilerplate to start writing your tutorial. A new folder will be created for your tutorial. Name of the folder is the same as the tutorial slug. Inside of this folder you will find:

content - folder with tutorial markdown files
builderdao.config.json - file with tutorial metadata
builderdao.lock.json - file with tutorial configuration. THIS FILE SHOULD NOT BE MODIFIED MANUALLY

Publishing

Once you are done writing your tutorial, commit your changes, push your tutorial branch to GitHub and create a PR. After 2 assigned reviewers approve your tutorial and merge it in, your tutorial will be automatically published.

zurgl/kafe