flatbread v1.0.0-alpha.20

Flatbread 🥪

Eat your relational markdown data and query it, too, with GraphQL inside damn near any framework (statement awaiting peer-review).

If it runs ES Modules + Node 14+, it's down to clown.

Born out of a desire to Gridsome (or Gatsby) anything.

☀️ Contributing

🚧 This project is currently experimental, is not ready for production, and the API may change considerably before v1.0. Feel free to hop in and contribute some issues or PRs!

Once you've installed dependencies with pnpm i -w, start a development server:

development server 🎒

This will run a dev server across packages in the monorepo

pnpm dev -w

working on a package ⚒️

Open another terminal tab.

Option 1: use the Playground as a demo project

This allows you to work in the full context of a Flatbread instance as an end-user would, except you can tinker with the packages internals.

cd playground
pnpm dev

This is a good option when you want to test without creating temporary clutter per-package that you wouldn't want to commit.

Option 2: scope to a specific package

In the new tab, scope yourself into the specific package you wanna mess with.

cd packages/<package>

Run the file containing where you invoke your function at the top level.

node dist/index.mjs # ya need Node v14.18+

build for production 📦

This will use tsup to build each package linked in the monorepo unless opted out per-package.

pnpm build

📓 Sidenotes

The transpiled TS files in the playground are being tracked in the repo to appease the Vite gods so I can develop quicker. As the project progresses, I'll likely yeet those outta here.

Huge shoutouts to @antfu and @sveltejs/kit for both having invaluable reference points to guide me through learning more advanced Node, Typescript, and monorepo design all in parallel during this project.