How mattplant/suitetools works
Project type and purpose
• This is a full-stack monorepo called *SuiteTools*—a set of missing NetSuite tools.
• The frontend is a React/TypeScript/Vite Single-Page App that you host in NetSuite’s File Cabinet.
• The backend is a set of SuiteScript 2.x modules (Suitelet, REST API script, Map/Reduce scripts) deployed via the SuiteCloud Development Framework (SDF) into your NetSuite account.
File structure
• Top-level directories:
• backend/ contains SDF configuration (suitecloud.config.js, deploy.xml, manifest.xml), XML definitions for custom records & scripts, TypeScript sources under src/TypeScripts/SuiteTools, File Cabinet templates under src/FileCabinet, and Jest tests.
• frontend/ contains a Vite + React + Tailwind CSS app with routes, API wrappers, components, pages, and build configs (vite.config.ts, tsconfig.json).
README for additional insights
• Built from the [NetSuite-TypeScript-SDF](https://github.com/mattplant/NetSuite-TypeScript-SDF) template.
• Deployment uses the SDF CLI to push both frontend assets (to File Cabinet) and backend SuiteScripts into your NetSuite account.
• The primary entry point is a Suitelet script (“SuiteTools App”) that either serves the SPA or functions as an API gateway.
• Labels: e.g., “Suitelet App Script,” “REST API Script,” “Map/Reduce Jobs,” “File Cabinet (SPA Assets),” “NetSuite Records.”
• Code → SDF CLI → NetSuite
• Browser → Suitelet → SuiteScripts → NetSuite Records → response → Browser
• Green rectangles for frontend (SPA assets, React components)
• Blue rectangles for backend SuiteScripts (Suitelet, API, Map/Reduce)
Capturing essential architectural elements
• Frontend components by feature (Concurrency, Files, Jobs, etc.) rather than listing each file.
• Clearly separate static hosting (File Cabinet) from compute (SuiteScript).
• SDF config files (suitecloud.config.js, deploy.xml, manifest.xml) to indicate “Infrastructure as Code.”
• Call out that the Suitelet doubles as both the UI server and API gateway.