paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-17 10:13:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

Minor changes

Browse Source
This commit is contained in:
Sebastian König 2021-02-26 12:50:12 +01:00
parent fd2cbc13ff
commit 5cb95b6e55
1 changed files with 2 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/extending.rst
View File

@ -3,9 +3,6 @@
Paperless development Paperless development
##################### #####################
General information
===================
This section describes the steps you need to take to start development on paperless-ng. This section describes the steps you need to take to start development on paperless-ng.
1. Check out the source from github. The repository is organized in the following way: 1. Check out the source from github. The repository is organized in the following way:
@ -56,12 +53,11 @@ To do the setup you need to perform the steps from the following chapters in a c
.. code:: shell-session .. code:: shell-session
pipenv install --dev pipenv install --dev
7. Generate the static UI so you can perform a login to get session that is required for frontend development (this needs to be done one time only). 7. Generate the static UI so you can perform a login to get session that is required for frontend development (this needs to be done one time only). From root folder:
.. code:: shell-session .. code:: shell-session
pipenv shell compile-frontend.sh
cd /src-ui && ng build --prod
8. Apply migrations and create a superuser for your dev instance: 8. Apply migrations and create a superuser for your dev instance:
.. code:: shell-session .. code:: shell-session
@ -85,9 +81,6 @@ Back end development
The backend is a django application. I use PyCharm for development, but you can use whatever The backend is a django application. I use PyCharm for development, but you can use whatever
you want. you want.
This will also create a virtual environment, which you can enter with ``pipenv shell`` or
execute one-shot commands in with ``pipenv run``.
Configure the IDE to use the src/ folder as the base source folder. Configure the following Configure the IDE to use the src/ folder as the base source folder. Configure the following
launch configurations in your IDE: launch configurations in your IDE: