Suggestions and pull requests are very welcome. 😊
To develop the project locally, you'll need node >= 18
and pnpm >= 8
.
git clone https://github.com/dexaai/dexter
cd dexter
pnpm i
You can now run the tsc
dev server to automatically recompile the project whenever you make changes:
pnpm dev
You can run the test suite via:
pnpm test
Or just the Vitest unit tests via:
pnpm test:unit
To run the included examples, clone this repo, run pnpm install
, set up your .env
file, and then run an example file using tsx
.
For example:
npx tsx examples/basic.ts
The ./docs/pages/docs
directory is autogenerated via typedoc and typedoc-plugin-markdown.
To rebuild the docs, run:
pnpm run docs
Please don't run this command when submitting PRs to keep them uncluttered, unless you're making changes to the docs themselves.
The docs folder is a normal Next.js pages app built using Nextra.
You can run the docs dev server to preview your changes via:
cd docs
pnpm dev
The docs are automatically deployed to Vercel.