Contribution Set-up

This page is out of date - check out the TinaCMS GitHub for the latest contribution information

Development

To get started:

Do not run npm install from inside the packages directory

TinaCMS uses Lerna to manage dependencies when developing locally. This allows the various packages to reference each other via symlinks. Running npm install from within a package replaces the symlinks with references to the packages in the npm registry.

Commands

Commands

Description

npm run bootstrap

Install dependencies and link local packages.

npm run build

Build all packages

npm run test

Run tests for all packages

lerna run build --scope <package>

Build only <package>.

lerna run watch

Watch all packages for rebuilds.

Run Development Packages

After installing the development setup you can run demo applications contained in the packages directory demo-cra, demo-gatsby and demo-next.

These projects can be used as a development environment for TinaCMS packages, you can edit any other package contained within TinaCMS packages.

When editing the packages of tina we can execute the command npm run dev to execute an development build on the repository packages.

This command will build all TinaCMS packages. This will reflect in the references of the tina demo packages, thus updating the demo packages according to the changes made.

This way you can change the tinacms packages and test the changes in the demo packages as a development environment.

Last Edited: February 18, 2021