diff --git a/README.md b/README.md index f609763..7668aab 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,20 @@ PLUGINS_CONFIG = { } ``` +## Developing + +### VSCode + Docker + Dev Containers + +To develop this plugin further one can use the included .devcontainer configuration. This configuration creates a docker container which includes a fully working netbox installation. Currently it should work when using WSL 2. For this to work make sure you have Docker Desktop installed and the WSL 2 integrations activated. + +1. In the WSL terminal, enter `code` to run Visual studio code. +1. Install the devcontainer extension "ms-vscode-remote.remote-containers" +1. Press Ctrl+Shift+P and use the "Dev Container: Clone Repository in Container Volume" function to clone this repository. This will take a while depending on your computer +1. If you'd like the netbox instance to be prepopulated run `make Makefile example_initializers` and `make Makefile load_initializers` +1. Start the netbox instance using `make Makefile all` + +Your netbox instance will be served under 0.0.0.0:8000 so it should now be available under localhost:8000. + ## Screenshots Access List - List View