To run BlockSuite from source, please ensure you have installed Node.js and pnpm.
pnpm install
pnpm devThen there would be multiple entries to choose from:
- The localhost:5173/starter/?init entry is recommended for local debugging.
- The localhost:5173/starter/ entry lists all of the starter presets.
- The localhost:5173 entry is a comprehensive example with local-first (IndexedDB-based) data persistence and real-time collaboration support.
All these entries are published to try-blocksuite.vercel.app.
And this would build the BlockSuite packages:
pnpm buildAdding test cases is strongly encouraged when you contribute new features and bug fixes. We use Playwright for E2E test, and vitest for unit test.
To test locally, please make sure browser binaries are already installed via npx playwright install. Then there are multi commands to choose from:
# run tests in headless mode in another terminal window
pnpm test
# or run tests in headed mode for debugging
pnpm test -- --debugIn headed mode, await page.pause() can be used in test cases to suspend the test runner. Note that the usage of the Playwright VSCode extension is also highly recommended.
To test browser compatibility, the BROWSER environment variable can be used:
# supports `firefox|webkit|chromium`
BROWSER=firefox pnpm test
# passing playwright params with the -- syntax
BROWSER=webkit pnpm test -- --debugTo investigate flaky tests, we can mark a test case as test.only, then perform npx playwright test --repeat-each=10 to reproduce the problem by repeated execution. It's also very helpful to run pnpm test -- --debug with await page.pause() added before certain asserters.
To test the real-time collaboration feature of BlockSuite locally, please follow these two simple steps:
- Open localhost:5173/starter/?init&room=hello in the first browser tab.
- Open localhost:5173/starter/?room=hello in a second tab.
See the documentation about what's happening under the hood.