monorepo/docs/internal/DEVELOPING.md
2024-07-06 11:58:08 -05:00

26 lines
776 B
Markdown

# Developers Guide
All developer dependencies have been built into a simple container image. Using Docker, or your preferred runtime of
choice, you can quickly spin up a shell with all the needed developer tooling.
```shell
# install pnpm for better monorepo support
npm install -g pnpm
pnpm config set store-dir $HOME/.pnpm
# spin up a shell
pnpm shell
```
### Targets
`pnpm packages` will output a list of all the packages within this repository.
`pnpm clean` will clean up any temporary installs and generated code.
`pnpm gen` generates code for the API layer.
`pnpm format` ensures that projects adhere to proper code style and makes any necessary modifications it needs to.
`pnpm lint` ensures that projects adhere to proper code style and fails if it does not.