A monorepo for TypeScript projects related to Synapse.org, a service provided by Sage Bionetworks.
We're using pnpm for dependency management and Nx for builds.
After cloning the repository, install dependencies with pnpm i.
You can build all packages with pnpm build.
You can test all packages with pnpm test.
For project-specific commands, see the relevant package.json in each project folder.
We're using pnpm workspaces to manage multiple projects.
├── ./apps - Standalone web applications
│ └── ./portals - Generates sites for data portals. Contains configurations for each maintained portal.
├── ./projects - Libraries and utilities that may or may not be published to NPM
│ └── ./synapse-react-client - React components and utilities used in Synapse.org and portals
└── ./shared - Shared configurations that are referenced across all projects
The main branch contains to the development version all packages. All changes should be merged into main.
For those packages that are deployed to npm, the deployment will occur when the version is changed in the main branch. A tag of the form <projectName>/v<version> will be created and applied to the commit which was deployed.
Sometimes, due to Synapse.org's deployment cadence, a hotfix must be based on an existing version of a package, rather than the latest version. To release a hotfix, create a branch based off of the tagged commit of the intended base version. Make your changes, and create a pull request to pull the hotfix into main. After your code is reviewed, change your local version of the package(s) to release to an appropriate value (e.g. 1.0.0-SWC-1234), and locally run pnpm -r publish. You will need to have configured your NPM credentials and have been granted access to publish our projects.