Skip to content

tyranid-org/tyranid

Repository files navigation

Tyranid npm version Build Status

Packages

Package Status Description
tyranid npm version Tyranid core library
tyranid-tdgen npm version TypeScript definition generator for tyranid
tyranid-graphql npm version Tyranid GraphQL driver
tyranid-gracl npm version Tyranid Permissions Library
tyranid-openapi npm version OpenAPI Spec Generator for Tyranid
tyranid-sanitize npm version Text sanitization plugin for Tyranid
tyreant npm version Ant driven UI component library for Tyranid

Development

First, install yarn and lerna:

npm i -g yarn lerna

Next, bootstrap the packages:

yarn

This will install all the dependences for each package in ./packages, along with the dev dependencies in the root ./package.json file. Finally, it simlinks the built packages to ./node_modules to allow the packages to reference eachother.

To check that the bootstrap was successfully, run the tests using the linked packages:

yarn test

Publishing

To ensure that tests are run across all packages before publishing, we use the following npm script to publish

yarn bump

This will internally call npm test && lerna publish, and the normal lerna publishing ui will come up.