Skip to content

lfsmoura/trust-bonds

Repository files navigation

Trust Bonds

Read more on our public website.

Important parts

  • /packages/contracts: all contracts and tests (@trust-bonds/contracts)
  • /docs/index.html: the public website for the project

Documentation

The project documentation is built using mdBook and includes support for Mermaid diagrams. To use Mermaid diagrams in the documentation:

  1. Write your diagram in a code block with the mermaid language specifier:
sequenceDiagram
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
Loading
  1. Run the documentation locally:
mdbook serve docs

Apps and Packages

These are stubs that will be useful in the future when we develop a dApp.

  • docs: a Next.js app with Tailwind CSS
  • ui: a stub React component library with Tailwind CSS shared by both web and docs applications
  • @repo/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • @repo/typescript-config: tsconfig.jsons used throughout the monorepo

In progress

We are currently working on launching a test contract on testnet.

  • Documentation
  • Community funds
  • Passport testnet
  • Score calculation
  • Upgrade typescript >= 5.4.0
  • Replace deprecated eslint

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •