Skip to content

CJWorkbench/hello-workbench

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hello-workbench

Example Workbench module for new developers.

Getting Started

  • Set up a Workbench development environment
  • Clone this repository into a sibling directory. For example, if Workbench is in ~/src/cjworkbench/cjworkbench, clone this repository into ~/src/cjworkbench/hello-workbench
  • Start Workbench in the Workbench directory: bin/dev start
  • Watch this module from the Workbench directory: bin/dev develop-module hello-workbench. Every time files change, this will re-import your module.
  • Browse to your local Workbench at http://localhost:8000 to try out your module.
  • Edit this module. Refresh in Workbench to see your edits.

Developing

  1. Add tests to test_module.py
  2. Run python3 test_module.py to find errors
  3. Edit code in module.py
  4. Push to GitHub

For lots more information, see the module development documentation.

About

Example Workbench module for new developers

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages