Skip to main content

Prerequisites

Before you begin, ensure your development environment meets the following requirements.

Overview​

LibreApps Desktop leverages modern web technologies and requires specific versions of tools to ensure a smooth development experience.

Required Tools​

1. Node.js​

LibreApps Desktop requires Node.js 20.x or later. We recommend using the latest LTS (Long Term Support) version.

2. pnpm​

We use pnpm as our primary package manager for its speed and efficiency in monorepo environments.

  • Check version: pnpm -v
  • Install: npm install -g pnpm

3. Git​

Git is required for version control and managing upstream submodules.

4. Bash Environment​

The rebranding engine and build scripts are written in Bash.

1. VS Code or Cursor​

While any editor works, we recommend VS Code or Cursor for their excellent TypeScript and Next.js support.

  • Extensions: ESLint, Prettier, Tailwind CSS IntelliSense.

2. Docker (Optional)​

Required if you plan to run the backend services (Keycloak, PostgreSQL, etc.) locally using Docker Compose.

Best Practices​

  • ✅ Do this: Use a version manager like nvm or fnm to manage Node.js versions.
  • ✅ Do this: Ensure your editor is configured to "Format on Save" using Prettier.
  • ❌ Don't do this: Use npm or yarn to install dependencies; it may lead to pnpm-lock.yaml conflicts.