Dream Trade Interface Description Language (IDL)

The API language for all Dream Trade microservices.

Setup Project

1. Install mise

• Install the mise CLI

brew install mise

• Add the mise activation command to your .zshrc

echo 'eval "$(mise activate zsh)"' >> ~/.zshrc

• Reload your .zshrc config (or restart your shell)

source ~/.zshrc

Note: You can follow the official installation docs for other options

2. Install project dependencies

• Use mise to install project dependencies

mise install

3. Install pre-commit hooks

• Use the makefile pre-commit-install command

make pre-commit-install

4. Install go modules

• Use go to install codebase modules

go mod tidy

5. Install node modules

• Install all node modules

npm install

Setup Database

1. Install Docker Desktop

• Follow the official Docker installation page

2. Configure Supabase

• Login to your Supabase account

supabase login

• Link the Supabase project

supabase link

Select the "DreamTrade" project when prompted

Common Scripts

• npm run lint - Lints all typescript files
• npm run check - Checks the syntax of all typescript files
• npm run gen - Generates typescript service clients
• make db-start - Starts the local Supabase database
• make db-stop - Stops the local Supabase database

Deployments

• Any merge to main with changes to the ts/* and go/* directory will trigger an automatic deployment to npm
• Any merge to main with changes to the supabase/* directory will trigger an automatic deployment to the remote database

Go Package

To import the Go packages in other repositories, you must follow the steps below to allow importing from a private repository.

1. Add an ssh override in your ~/.gitconfig

[url "[email protected]:"]
  insteadOf = https://github.com/

2. Add the following export within your ~/.zshrc

export GOPRIVATE=github.com/RivasCVA/*