Skip to content

Latest commit

 

History

History
167 lines (140 loc) · 27.3 KB

README.md

File metadata and controls

167 lines (140 loc) · 27.3 KB

Tweet Slack Lerna All Contributors

TINA CMS

Tina is an open-source toolkit for building content management directly into your website.

Tina Demo

Learn More

Development

Disclaimer:

  • Tina is a new and fast moving project. Although API stability and easy developer experience is important to the core team, they cannot be guaranteed while the project is pre-1.0.
  • Although Tina supports many use cases not all of them have helper packages or comprehensive guides. If you’re looking to use Tina in a novel way you will have to do a lot of manual setup.

To get started:

git clone git@github.com:tinacms/tinacms.git
cd tinacms
npm install
npm run build

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

WARNING: 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 --scope <package> Build a the <package> in watch mode.

Testing With External Projects

Linking apps to a monorepo can be tricky. Tools like npm link are buggy and introduce inconsistencies with module resolution. If multiple modules rely on the same package you can easily end up with multiple instances of that package, this is problematic for packages like react which expect only one instance.

@tinacms/webpack-helpers provides tools and instructions for testing local TinaCMS changes on external websites.

Release Process

TinaCMS packages are updated every Monday.

Checkout the RELEASE file for the details.

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

💻

Dani Tulp

💻 🤔

PaulBunker

💻

JavaScript Joe

💻

Madelyn Eriksen

📝

Marc Mintel

🚇 💻 🐛

Jeff See

🚇

Brandon Landfried

🐛

Chad Johnson

🐛

David Arnold

🤔

Gavin McFarland

🐛

blandfried

🐛 💻

Mark Lawlor

🤔

Ben Scott

👀

Brent Mitton

💻 📖

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