jsjoeio / tinacms

Tina is a site editing toolkit for modern React-based sites (Gatsby and Next.js)

 

Getting Started

• Website
• Documentation
• Slack
• Forum
• Roadmap
• Contributing
  • How to Contribute
  • Creating Packages
  • Troubleshooting in Development

Development

To get started:

git clone [email protected]:tinacms/tinacms.git
cd tinacms
npm install && npm run bootstrap
npm run build

# Start 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.

Commands

Commands	Description
npm run bootstrap	Install dependencies and link local packages.
npm run build	Build all packages.
npm run watch	Watch all packages for rebuilds.
npm run test	Run tests for all packages.
lerna run build --scope <package>	Build only <package>.

Testing With External Projects

Currently, testing with external projects is somewhat inelegant, but this repo includes a folder designed for importing external projects into the monorepo so the development versions of Tina packages can be bootstrapped into the project. To import an external project:

1. git clone or simply copy the project into the packages/@testing folder. Everything in this folder is ignored by git.
2. In the root of the monorepo, run npm run bs to link the necessary development packages
3. Navigate to your project folder and develop normally

Pitfalls of Testing with External Projects

• Running npm run build in the root of the monorepo will run a build script if your project has one defined. If this causes problems (tina may be causing your build to fail in the first place, and you want to skip the build for now but still build the other packages,) you can get around this by either running lerna run build --ignore=YOUR_PACKAGE_NAME or adding the name of your package to the ignore array for the run command in lerna.json.

//lerna.json
{
  "command": {
    "run": {
      "ignore": ["YOUR_PACKAGE_NAME"]
    }
  }
}

• Gatsby and React both rely on some globally-persisted values which can cause errors if you have multiple copies of these dependencies installed. When testing a Gatsby site, many issues can be worked around by temporarily deleting the demo-gatsby package and bootstrapping again.

Release Process

Tina has two main branches:

• master: The bleeding edge of tinacms
• latest: The current stable release

The flow of changes therefore looks like:

fix-some-bug => master => latest

This is a weekly process:

• On Monday master is merged into latest which is then published to npm.
• Hot fixes are cherry picked onto latest and then published.
• Prereleases are created off of master whenever they're needed.

With this process:

• critical fixes are published as soon as possible
• new features and minor fixes take 3-5 days to be published

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Forestry.io 💵	NCPhillips 📆 💻 📝 🐛 📖 🤔 🚇 🚧 👀 ⚠️	DJ 📆 💻 📝 🐛 📖 🤔 🚧 👀 ⚠️	Scott Byrne 🎨 💻 👀 🚧 📖	James O'Halloran 📆 🐛 🤔 🚧 👀 ⚠️ 💻	Kendall Strautman 🎨 📆 🐛 🤔 🚧 📢 👀 💻	Nichlas Wærnes Andersen 💻 🎨 🤔
Jordan 📆 📢 🤔 🐛	Frank Taillandier 👀 📖 📆 📓	Scott Gallant 📖 📢 🔍	Mitch MacKenzie 📓	zacchg 📓	Lyle Underwood 🐛 💻	Laura1111999 📖
Thom Krupa 📓	Michael Gauthier 📓	dcgoodwin2112 📖	akshayknz 📖	Adam Silverstein 📖	Brad McGonigle 💻	Jake Coxon 💻
Ladislav Prskavec 💻	Bolarinwa Balogun 🚇	Mason Medeiros 📓	ironsean 📓	kyp 🐛	Vladislav Shkodin 🐛	maciek_grzybek 🤔 💻
weibenfalk 📹 📝 💻	David Bergeron 🐛	Kellan Martin 💻	Jon Miller 🤔	Paul 🐛	Chris Flannery 💻	Jefferson Bledsoe ⚠️
Kenia 💻	Andrew James 💻	Zach B 📢	Jyoti Puri 💻	nibtime 💻 🐛	Johan Soulet 💻 🐛	Cleiton Pereira 🐛
chrisdmacrae 🚇 💬 🤔	jhuggett 💻	Nicolas Cisco 💻 ⚠️	Hungry Bear Studio 💻	Alex Barbato 💻

This project follows the all-contributors specification. Contributions of any kind welcome!