Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.89 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.89 KB
Raw

PieDAO Styled with Prettier Commitizen Friendly

Monorepo implementing the PieDAO application layer.

Contributing

Feel free to dive in! Open an issue. For any concerns or feedback, join us on Discord.

Prerequisites

You will need the following software on your machine:

The project is build with Nx, so familiarity with Nx monorepos is advised. If using VS code, consider adding the Nx Console extension to get started with a GUI.

In addition, familiarity with TypeScript and React is a prerequisite.

Set Up

You need to install the dependencies:

npm i

The next step is to call the setup script:

script/setup

Next, run patches if any

patch-package

Now you can start making changes.

Packages

This project contains multiple individual packages that can be deployed separately:

  • auxo is the primary investing application
  • auxo-e2e lets you run automated e2e tests using Cypress
  • Backend contains the server component of the project.
  • Landing Page the landing page
  • SDK contains a collection of utilities that assist with connecting to on-chain data
  • Funds domain model and business functions for Funds

You can follow the links above to refer to the documentation of those projects.