A design-for-manufacturability application for uploading a CAD part, starting Toolpath Engine analysis, and inspecting the resulting features and mesh. Use this repository as a GitHub template to build your own Toolpath API powered product.
See https://developers.toolpath.com/ for documentation on using the Toolpath API.
-
Create a new github repository and select Start with a template to use this repository as a base to build your own application.
-
Install Node.js 24.18 or newer. Node.js is the program that runs this application on your computer. Download and install it from nodejs.org. Then open Terminal on macOS or Linux, or PowerShell on Windows, and run:
node --version corepack enableThe first command should show
v24.18.0or a higher version. Corepack comes with Node.js and turns on the exact version ofpnpmthat this project needs to install and run its files. -
Create your private local settings file:
pnpm setup:local
This creates
apps/dfm/.env, a private file that stays on your computer and is not added to GitHub. It generates the session secret without displaying it and sets the standard Toolpath API URL. It also installs the application files it needs.This also installs the Husky pre-commit hook. It formats staged files automatically before each commit so you can have nice formatting without having to think about it.
-
Start the application:
pnpm dev
Open the local address shown in the terminal, usually http://localhost:5173. You are ready when the Toolpath connection screen appears.
pnpm check # Run all quality checks
pnpm test:e2e # Run playwright E2E tests
pnpm --filter @toolpath/dfm docker:build # Build DFM app docker containerThe application uses released @toolpath/api, @toolpath/ui, and @toolpath/viewer NPM packages.
See the application README for architecture and request-flow details.
This project is licensed under the MIT License.