Template for NodeCG bundles that use React and TypeScript. Heavily inspired by zoton2's nodecg-vue-ts-template template.
- Extension uses TypeScript.
- Browser uses React v18, with TSX support by default.
- Includes use-nodecg for easy use of replicants compatible with React Hooks.
- Dashboard includes Material UI configured for dark mode by default for easy styling.
- ESLint is included for help with writing proper code.
- Includes eslint-plugin-react-hooks and eslint-plugin-react-refresh to help with writing React Hooks.
- The extension/browser files have some example code scattered about that should help in how to use things.
- Prettier is included with a bit of an opinionated config. Feel free to change it to your own likings.
autofix
: Automatically fix any possible linting errors using ESLint.autofix:browser
: See above, but only for browser based code.autofix:extension
: See above, but only for extension based code/typings.build
: Build written code for use in production.build:browser
: See above, but only for browser based code.build:extension
: See above, but only for extension based code.clean
: Clean up all built/watched files.lint
: Finds any possible linting errors using ESLint, but does not fix them.prebuild
: Alias forclean
, will automatically run beforebuild
if called.prettify
: Runs Prettify on the browser and extension source code.schema-types
: Create TypeScript typings for schemas/Configschema.json
usingnodecg-cli
.start
: Start NodeCG.watch
: Build code and watch for changes, for use in development.watch:browser
: See above, but only for browser based code.watch:extension
: See above, but only for extension based code.