README.md

Cristal

What's Cristal

• A new xwiki.org project to provide a modern knowledge base front-end
• A wiki UI to rule them all: Provide a UI that can be plugged onto various content backends (XWiki, local file system, GitHub, etc.)
• Usable in various forms:
  • From a URL in your browser
  • Executable locally on your computer (Electron application).
  • Embeddable in backends. For example, the intent on the long run is to have Cristal be used by XWiki as its native UI
• Ability to work offline, reconnect, and sync content.

Useful links

• Roadmap
• Architecture
• Technological Choices
• Wireframes
• UI Components
• Backends
• GitHub repository
• Forum

Project details

• 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

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