excalidraw-persist
Self-hosted Excalidraw with persistence and multiple boards
File Explorer
Download Latest Version (.zip)- docker-publish.yml
- excalidraw-icon.svg
- Assistant-VariableFont.ttf
- ArchivePopup.tsx
- BoardPage.tsx
- ExcalidrawEditor.tsx
- Header.tsx
- Icon.tsx
- Loader.tsx
- SharePage.tsx
- SharePopup.tsx
- Tab.tsx
- Toast.tsx
- BoardProvider.tsx
- ThemeProvider.tsx
- ToastProvider.tsx
- useExcalidrawEditor.ts
- api.ts
- boardService.ts
- elementService.ts
- libraryService.ts
- shareService.ts
- App.scss
- ArchivePopup.scss
- BoardPage.scss
- ExcalidrawEditor.scss
- global.scss
- Header.scss
- Loader.scss
- reset.scss
- SharePage.scss
- SharePopup.scss
- Tab.scss
- Toast.scss
- types.ts
- index.ts
- logger.ts
- App.tsx
- main.tsx
- vite-env.d.ts
- .eslintrc.cjs
- .eslintrc.json
- Dockerfile
- index.html
- nginx.conf
- package.json
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
- vite.config.ts.timestamp-1742747302607-98de530cc8682.mjs
- env.ts
- index.ts
- boardController.ts
- elementController.ts
- libraryController.ts
- shareController.ts
- database.ts
- migrations.ts
- schema.sql
- errorHandler.ts
- boardModel.ts
- elementModel.ts
- fileModel.ts
- index.ts
- libraryModel.ts
- shareLinkModel.ts
- boardRoutes.ts
- elementRoutes.ts
- index.ts
- libraryRoutes.ts
- shareRoutes.ts
- index.ts
- logger.ts
- index.ts
- .env.example
- .eslintrc.json
- Dockerfile
- package.json
- tsconfig.json
- .dockerignore
- .editorconfig
- .eslintignore
- .gitignore
- .prettierignore
- .prettierrc
- docker-compose.dev.yml
- docker-compose.yml
- Dockerfile
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- supervisord.conf
# Installation Guide
1. Get the code
git clone https://github.com/ozencb/excalidraw-persist
Downloads the entire project code from GitHub to your computer.
cd excalidraw-persist
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Node.js Node.js must be installed to use npm.
npm install -g pm2
Installs the package published on the npm registry globally β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker-compose up -d
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
4. Node.js
EasyPrerequisites
pnpm install
Downloads and installs the libraries listed in package.json.
pnpm dev
Starts the development/run server.
pnpm build
Type this command into your terminal and run it.
pnpm start
Starts the development/run server.
npm install -g pm2
Installs the package published on the npm registry globally β no need to clone the source.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)