@@ -60,17 +60,13 @@ ln -s "$(pwd)" "$(fiftyone config plugins_dir)/voxelgpt"
6060
6161### Build JavaScript assets outside of fiftyone-plugins repository [ Optional]
6262
63- To build a plugin with JavaScript assets (i.e. Panel, Operators, etc.) outside
64- of this repository, some additional configuration is required. Take a look at
65- [ voxelgpt] ( https://github.com/voxel51/voxelgpt/blob/main/vite.config.js ) plugin
66- repository for an example of configurations required for JavaScript build
67- externally. Mainly, your ` vite.config.js ` will need to be similar to
68- ` vite.config.js ` of
69- [ voxelgpt] ( https://github.com/voxel51/voxelgpt/blob/main/vite.config.js )
70- plugin. Additionally, you will need to install the dependencies listed in
71- ` vite.config.js ` (i.e. ` vite ` , ` @vitejs/plugin-react ` ,
72- ` @rollup/plugin-node-resolve ` , ` vite-plugin-externals ` , etc.) as a
73- dev-dependencies for your JavaScript plugin project.
63+ To get started with building a new JavaScript plugin outside of
64+ fiftyone-plugins repository, use the
65+ [ hello-world-plugin-js] ( https://github.com/voxel51/hello-world-plugin-js )
66+ repository as a base. It provides a minimal, working template that includes a
67+ sample JavaScript operator and a sample JavaScript panel. Clone the repository,
68+ rename it appropriately, and customize the operator and panel to fit your use
69+ case.
7470
7571## Tests
7672
@@ -109,6 +105,6 @@ bash run_tests.sh hello_world
109105
110106You can also use pytest directly by emulating the setup in ` run_tests.sh ` .
111107
112- - Ensure you have ` $FIFTYONE_PLUGINS_DIR/plugins ` in your ` PYTHONPATH `
113- - Run a test file and use ` pytest ` as expected
114- - eg ` pytest ./plugins/hello_world/test_count_samples.py -v `
108+ - Ensure you have ` $FIFTYONE_PLUGINS_DIR/plugins ` in your ` PYTHONPATH `
109+ - Run a test file and use ` pytest ` as expected
110+ - eg ` pytest ./plugins/hello_world/test_count_samples.py -v `
0 commit comments