The master branch does not store source code of SDKs, instead code is stored
in the SDK branches and version tags:
- latest SDK branch:
typescript/{SDK_ID}, for exampletypescript/lmsapi - versioned SDK tag:
typescript/{SDK_ID}/v{VERSION}, for exampletypescript/lmsapi/v0.1.0
Install the package from npm:
npm install @cu-devs-collective/open-cu-services-lmsapiIf you need to install a specific repository tag, use a package manager
that supports git dependencies with a subdirectory path. Recommended package
manager for this flow is pnpm.
Add the dependency to your package.json:
{
"dependencies": {
"@cu-devs-collective/open-cu-services-lmsapi": "git+https://github.com/cu-devs-collective/open-cu-services-sdk#typescript/lmsapi/v0.1.0&path:/typescript/lmsapi"
}
}Then install dependencies:
pnpm installSee examples/typescript
for runnable examples.
When working against a local checkout of a generated SDK branch or tag, use a
file dependency. This works for npm and pnpm:
{
"dependencies": {
"@cu-devs-collective/open-cu-services-lmsapi": "file:../../typescript/lmsapi"
}
}Then install dependencies with your package manager:
# npm
npm install
# pnpm
pnpm installThis override only works when the checked-out ref contains the generated package
at typescript/lmsapi.
Please read Reporting Issues for Codegen Clients and use the Codegen client issue report template for codegen client issues.