inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2026-07-09 00:21:34 +00:00
Code Activity

Documentation update; New frontend docs, additional info on devcontainer (#5974)

Browse Source 
* Add Frontend dev docs, and expand devcontainer docs

* Grammatical fixes
This commit is contained in:
Lavissa
2023-11-23 02:21:09 +01:00
committed by GitHub
parent f7a8707a9a
commit f4ba7a1698
2 changed files with 71 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/develop/devcontainer.md
+10 -1
View File
@@ -24,7 +24,12 @@ You need to make sure that you have the following tools installed before continu
```
2. open vscode, navigate to the extensions sidebar and search for `ms-vscode-remote.remote-containers`. Click on install.
3. open the cloned folder from above by clicking on `file > open folder`
4. vscode should now ask you if you'd like to reopen this folder in a devcontainer. Click `Reopen in Container`. If it shouldn't ask you open the command palette (<kbd>CMD</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>) and search for `Reopen in Container`. This can take a few minutes until the image is downloaded, build and setup with all dependencies.
4. vscode should now ask you if you'd like to reopen this folder in a devcontainer. Click `Reopen in Container`. If it does not ask you, open the command palette (<kbd>CTRL/CMD</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>) and search for `Reopen in Container`. This can take a few minutes until the image is downloaded, build and setup with all dependencies.
5. Open a new terminal from the top menu by clicking `Terminal > New Terminal`
6. The last line in your terminal should now show the text `(venv)` at the start of the line
7. From here' we need to setup the InvenTree specific development environment
8. From the newly opened terminal, run: `invoke install`
9. If you want test data on your server, run: `invoke setup-test --dev`. If not, run `invoke setup-dev`
### Setup in codespaces
@@ -58,6 +63,10 @@ You can either only run InvenTree or use the integrated debugger for debugging.
You can now set breakpoints and vscode will automatically pause execution if that point is hit. You can see all variables available in that context and evaluate some code with the debugger console at the bottom. Use the play or step buttons to continue execution.
!!! info "React Frontend development"
The React frontend requires additional steps to run. Refer to [Platform UI / React](./react-frontend.md)
### Plugin development
The easiest way for plugin developing is by using the InvenTree devcontainer. Just mount your plugin repository also into the devcontainer workspace and install it as pip editable package.