Contribution Set-up


To get started:

git clone
cd tinacms
npm install
npm run bootstrap
npm run build

# Start the Gatsby demo
cd packages/demo-gatsby
npm run start

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.


npm run bootstrapInstall dependencies and link local packages.
npm run buildBuild all packages
npm run testRun tests for all packages
lerna run build --scope Build only .
lerna run watchWatch 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 Tina packages, you can edit any other package contained within Tina 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 Tina 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