From 42a082916a3abe6ac2babefa583811d1fe806f78 Mon Sep 17 00:00:00 2001 From: Arthur Date: Wed, 24 Aug 2022 16:09:43 -0700 Subject: [PATCH] #10139 update development documents for githooks and web-ui --- docs/development/getting-started.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/development/getting-started.md b/docs/development/getting-started.md index 38d521de6..b14299153 100644 --- a/docs/development/getting-started.md +++ b/docs/development/getting-started.md @@ -54,6 +54,12 @@ NetBox ships with a [git pre-commit hook](https://githooks.com/) script that aut cd .git/hooks/ ln -s ../../scripts/git-hooks/pre-commit ``` +For the pre-commit hooks to work, you will also need to install the pycodestyle package for the pre-commit hooks to work: + +```no-highlight +python -m pip install pycodestyle +``` +...and setup the yarn packages as shown in the [Web UI Development Guide](web-ui.md) ### 3. Create a Python Virtual Environment @@ -118,6 +124,10 @@ This ensures that your development environment is now complete and operational. !!! tip "IDE Integration" Some IDEs, such as the highly-recommended [PyCharm](https://www.jetbrains.com/pycharm/), will integrate with Django's development server and allow you to run it directly within the IDE. This is strongly encouraged as it makes for a much more convenient development environment. +## UI Development + +For UI development you will need to review the [Web UI Development Guide](web-ui.md) + ## Populating Demo Data Once you have your development environment up and running, it might be helpful to populate some "dummy" data to make interacting with the UI and APIs more convenient. Check out the [netbox-demo-data](https://github.com/netbox-community/netbox-demo-data) repo on GitHub, which houses a collection of sample data that can be easily imported to any new NetBox deployment. (This sample data is used to populate the public demo instance at .)