everkit-config

everkit-config is one shared set of house rules for how the code in our apps is written, checked and built. Tea Companion, Dial It In and Matcha Companion follow it, and so do the other everkit packages

The problem it solves

Every app needs the same behind-the-scenes setup. It needs rules for how code should look, checks that catch common mistakes, and settings that turn the code into a working app

When each app keeps its own copy of that setup, the copies slowly drift apart. One app gets formatted one way, another misses mistakes the first one catches, and changing a rule means changing it in every app by hand

everkit-config keeps a single copy of those rules. Each app points to it instead of keeping its own

What an app gets

• One look for all code, so every file in every app is laid out the same way and reads the same
• Automatic mistake checks, which flag common errors before they reach anyone using the app
• Clear walls inside the app, which stop one part of the app from reaching into a part it should not touch
• Shared build settings, so every app turns its code into a working app in the same way
• Shared layout sizes, so the spacing and rounded corners from the everkit UI kit look the same everywhere
• A check for written guides, which flags broken links, stale wording and details that quickly go out of date

An everyday analogy

Think of a small chain of cafés that share one recipe book. Each café has its own kitchen and its own menu extras, but the core recipes, measurements and hygiene checks come from the same book. When head office improves a recipe, each café picks up the change the next time it refreshes its copy, and a customer gets the same coffee wherever they order it

An app can still add its own extra rules on top, the same way a café can add a local special without rewriting the book

For developers: see ARCHITECTURE.md