-
Python
NB Defense requires python version greater than
3.8
and less than3.11
-
Poetry
The following install commands require Poetry. To install Poetry you can follow this installation guide. Poetry can also be installed with brew using the command
brew install poetry
.
-
Run
make install
to install the pip dependencies to the current python environment -
Run
make start-dev
to run a development server locally -
Go to
http://127.0.0.1:8000/
to view the docs
We are using the following libraries for our documentation:
- Live Documentation
- This is where the production build is hosted
- MkDocs
- This is the static site generator we're using
- Material for MkDocs
- This is the theme we're using for MkDocs