nextcloud / nextcloud/whiteboard

Document build steps with @nextcloud/excalidraw

Open
#883 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
215
Forks
39
Avg merge
1d 3h
Merged PRs (30d)
32

Description

  • Document development steps
  • Document release steps

My attempt locally:

cd ~/repos/nextcloud/excalidraw

cd packages/excalidraw
yarn && yarn build:esm
yarn link
cd ../../

cd packages/elements
yarn
yarn link @nextcloud/excalidraw
yarn build:esm

cd ~/repos/nextcloud/server/apps-extra/whiteboard
npm ci
npm link ~/repos/nextcloud/excalidraw/packages/{common,math,excalidraw,element}
--- a/vite.config.ts
+++ b/vite.config.ts
@@ -6,6 +6,7 @@ import react from '@vitejs/plugin-react'
 import { defineConfig, normalizePath } from 'vite'
 import { join, resolve } from 'path'
 import { viteStaticCopy } from 'vite-plugin-static-copy'
+import { nodePolyfills } from 'vite-plugin-node-polyfills'

 const EXCALIDRAW_FONTS_DIR = normalizePath(resolve('node_modules/@nextcloud/excalidraw/dist/prod/fonts'))

@@ -62,6 +63,9 @@ const AppConfig = createAppConfig({
                        jsxInject: 'import React from \'react\'',
                },
                plugins: [
+                       nodePolyfills({
+                               include: ['process', 'buffer', 'global'],
+                       }),
                        react({
                                jsxRuntime: 'classic',
                        }),

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the development commands for packages/excalidraw, packages/elements, and the whiteboard app, then inspect vite.config.ts and the existing documentation. Verify the documented development and release steps against the repository's current scripts. Done means both checklists are complete and a newcomer can follow them without relying on local linking assumptions.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.