Credbull DeFI (credbull-defi)

---

Project Structure

• packages/ Individual sub-projects

  • api/ Our backend API Server (NestJS)
  • app/ Our frontend app (NextJS)
  • contracts/ Smart Contracts and Tests

• scripts/ Scripts to automate any manual task we need

  • operation/ Scripts for operational tasks

• spikes/ Any POC or research we do

---

Setup project locally

• If you only want to work on the contracts, you don't need to setup the whole project. Please go directly to contracts/ and follow the instructions there.

• Ensure that you have installed:

  • NodeJS v21+ (install node.js)
  • Yarn (install yarn)
  • Foundry (install forge)
  • Docker (install docker)
  • Supabase CLI (install the cli)
    • Hint: choose a native client for your platform instead of the npm package

• Install the project dependencies with yarn install

• Ensure you have the environment variables for local development:

  • In package/api, run cp -v .env.local.sample .env.local
  • In package/app, run cp -v .env.local.sample .env.local
  • In package/contracts, run cp -v .env.sample .env
  • In package/sdk, run cp -v .env.sample .env
    • NOTE: Further setup required. See SDK README.md.
  • In scripts/operation, run cp -v .env.sample .env
    • NOTE: Further setup required. See Operations README.md.

• Start the database (Supabase)

  • In packages/api, run supabase start
  • Follow the instructions from the CLI.

---

Test Locally

• After the project has been setup locally you can just yarn test
• NOTE: JL 2024-05-08, test for the sdk package has been re-named to int-test as it was interfering with developer workflow. The Notion issue.

---

Run and Deploy Locally

• Run yarn dev
• Run open http://localhost:3000

---

Slack Integration

For subscribing to notifications of interest from the GitHub repository. This is covered in detail here.

TL;DR

• Install the GitHub app within your Slack Workspace using this link.

• Connect your Slack & GitHub accounts as per instructions (it's time-limited).

• Setup your GitHub subscriptions as desired. For example, to receive notifications for Issue and Pull Request changes, for credbull-defi, enter the following in the GitHub app:

  /github credbull/credbull-defi unsubscribe commits releases deployments

• Tune your notifications to taste and enjoy the plethora of information at your fingertips!

---