Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.21 KB
Raw

Contributing

Warning

We are focused on developing the core platform at the moment so the developer onboarding experience is very rough.

Feel free to reach out in the Discord if your having problems!

Warning

This guide should not be used for a production deployment. It is setup strictly for development purposes.

To contribute you will require:

  • A MySQL database
  • Azure app registration - used for the Entra ID identity provider
  • AWS credentials - used for SES

And have the following software installed:

# API & Web UI
pnpm i
cp .env.example .env
pnpm dev
# pnpm db:push
# pnpm db:studio

# MDM backend
cargo mattrax init
cargo mattrax serve

# CLI
cargo mttx help

Things to know:

Unidirectional dataflow

All data follows the following order:

  • User or device -> API (Typescript) -> Rust -> DB
  • I will not flow backwards,
  • It may and probably will skip layers

tRPC

TODO: authedProcedure vs tenantProcedure and when to pick each.

TODO: flushResponse

Drizzle to RS

TODO: Explain why we have this