PatchCanvas

A tool for documenting patches between professional hardware and software components

Check it out, it's live here: patchcanvas.net

Developer overview

PatchCanvas is this project, and it uses:

• Node.js as the development JavaScript runtime environment
• Vite as the project management and build system
• Yarn as the package (and some project) management system
• Svelte as the component-based compositional compiled UI framework
• xyflow as the node-based UI library for Svelte
• GitHub Pages for hosting the compiled application
• gh-pages as a Node.js utility for publishing to GitHub Pages

How to contribute

Clone the repository

git clone https://github.com/theonlytechnohead/patchcanvas.git

This downloads all the code and assets to your device

Install dependencies

yarn

This fetches and sets up all the required libraries and dependencies for running the project

Run the dev environment

yarn dev

This will start up a web server that you can connect to at https://localhost:5173 and supports hot-reload of your changes (on supported configurations)

(Optionally) Compile the app for testing

yarn build

This will compile all the Svelte code into native JavaScript and TypeScript and CSS and HTML and bundle it all together into one or two files

When I accept your pull request, I will publish the app

yarn deploy

You'll probably never be able to run this command, as you don't have permission to push directly to this repository