README.md

Cristal

Cristal is a new project to build a new modular wiki UI using modern web technologies, which will support multiple backends (including of course XWiki to store wiki data, and provide back-end services).

• Project Lead: Manuel Leduc
• Documentation & Downloads: N/A
• Issue Tracker
• Communication: Forum
• Development Practices
• Minimal XWiki version supported: N/A
• License: LGPL 2.1
• Translations: N/A
• Sonar Dashboard: N/A
• Continuous Integration Status:

Project Setup

pnpm install

Starting the project

Starting on default port 9000.

pnpm run start

Starting on an arbitrary port (e.g., 9001)

HTTP_PORT=9001 pnpm run start

Compile and Minify for Production

pnpm run build

Run Unit Tests with Vitest

pnpm run test

Run Functional Tests with Playwright

pnpm run --filter ./web test:e2e
## Or, if port 9000 is already used
HTTP_PORT=9001 pnpm run --filter ./web test:e2e

After a playwright upgrade, the following commands need to be executed to make sure to have the system dependencies and browsers up to date.

pnpx playwright install
pnpx playwright install-deps

Lint

pnpm lint