mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-29 11:09:27 -05:00
documentation updated for devcontainers
This commit is contained in:
parent
90130e8873
commit
5bf0135879
BIN
docs/assets/screenshots/devcontainer_environement_ready.png
Normal file
BIN
docs/assets/screenshots/devcontainer_environement_ready.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 202 KiB |
BIN
docs/assets/screenshots/devcontainer_run_debug.png
Normal file
BIN
docs/assets/screenshots/devcontainer_run_debug.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 150 KiB |
BIN
docs/assets/screenshots/vscode_prompt_devcontainer.png
Normal file
BIN
docs/assets/screenshots/vscode_prompt_devcontainer.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 62 KiB |
@ -450,3 +450,66 @@ def myparser_consumer_declaration(sender, **kwargs):
|
||||
mime types have many extensions associated with them and the Python
|
||||
methods responsible for guessing the extension do not always return
|
||||
the same value.
|
||||
|
||||
## Easy startup with devcontainers
|
||||
|
||||
The easiest way to get started with development is to use Visual Studio Code with devcontainers.<br>
|
||||
This approach will create a preconfigured development environment with all the tools you need.<br>
|
||||
[Learn more about devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
[Docker Desktop](https://docs.docker.com/get-docker/) <br>
|
||||
[Visual Studio code](https://code.visualstudio.com/) <br>
|
||||
|
||||
### Getting started:
|
||||
|
||||
#### 1) Clone the repository on your machine
|
||||
|
||||
#### 2) Open the paperless-ngx folder in Visual Studio Code
|
||||
|
||||
#### 3) Visual Studio Code will prompt you with "Reopen in container"
|
||||
|
||||
{: style="width:32%"}
|
||||
|
||||
#### 4) Wait for the dev environment to spinn up
|
||||
|
||||
{: style="width:32%"}
|
||||
|
||||
#### 5) You have to run the task for the project initialisation
|
||||
|
||||
Run Task labeled: **Project Setup: Run all Init Tasks**
|
||||
|
||||
> Open the 'Run Task' menu in Visual Studio Code:
|
||||
> Open via menu
|
||||
>
|
||||
> Terminal -> Run Task
|
||||
|
||||
> Open via keyboard shortcut
|
||||
>
|
||||
> - Mac: **Shift+Command+T**
|
||||
> - Windows/Linux: **Ctrl+Shift+T**
|
||||
|
||||
This task will:
|
||||
|
||||
- initialise the database tables
|
||||
- create the superuser for paperless
|
||||
|
||||
> you will be prompted to create the superuser for paperless
|
||||
|
||||
- compile the front end for production
|
||||
> this is necessary if run run only the backend server in order to have a front end application
|
||||
|
||||
#### 6) Now the project is ready for debugging
|
||||
|
||||
- Set your breakpoints
|
||||
|
||||
- Start either run the fullstack debug or individual debug processes
|
||||
|
||||
{: style="width:32%"}
|
||||
|
||||
> note that the debug option **Chrome: Debug Angular Frontend** is a 2 step process.
|
||||
>
|
||||
> first it starts task labeled **Start: Frontend Angular** and when angular is ready it will open a chrome browser for debugging
|
||||
|
||||
**Note**: If you only want to spinn up the whole project without debugging you can run the task labeled **Project Start: Run all Services**
|
||||
|
Loading…
x
Reference in New Issue
Block a user