fix(developer): combine ExApp development setup pages

Signed-off-by: Edward Ly <contact@edward.ly>
This commit is contained in:
Edward Ly
2024-10-30 14:21:51 -07:00
parent 450fc06665
commit 3279c14a0a
4 changed files with 19 additions and 28 deletions

View File

@@ -3,7 +3,9 @@
Setting up dev environment
==========================
We highly recommend using `Julius Knorr's Docker setup <https://github.com/juliusknorr/nextcloud-docker-dev>`_ for Nextcloud development.
AppAPI development requires a Nextcloud development environment setup.
We highly recommend using `Julius Knorr's Docker setup <https://github.com/juliusknorr/nextcloud-docker-dev>`_ for this.
For an alternate environment without using Docker, please refer to the `Nextcloud development environment docs <https://docs.nextcloud.com/server/latest/developer_manual/getting_started/devenv.html>`_.
Suggested IDE: **PhpStorm**, though you can certainly use any IDE of your preference such as **VS Code** or **Vim**.
@@ -42,6 +44,21 @@ Enable AppAPI from the directory where the ``occ`` command resides:
./occ app:enable --force app_api
Deploy daemons types
********************
There are two types of Deploy daemons that can be used for development and testing of ExApps:
1. ``manual_install``: This type of Deploy daemon is running manually in the host machine.
You can create it in AppAPI admin settings using template.
This is useful for development of ExApp, when you run your ExApp manually in the host.
2. ``docker_install``: This type of Deploy daemon is running in a Docker container.
Docker Socket Proxy
*******************
For development and testing locally, the simplest is to use the `Nextcloud AppAPI DSP HTTP <https://github.com/cloud-py-api/docker-socket-proxy?tab=readme-ov-file#httplocal>`_.
In Place of a Conclusion
""""""""""""""""""""""""

View File

@@ -1,25 +0,0 @@
.. _DevelopmentEnvironment:
Development environment
=======================
The development environment for AppAPI first of all requires a default Nextcloud dev setup.
You can find more information on that in the `Nextcloud development environment docs <https://docs.nextcloud.com/server/latest/developer_manual/getting_started/devenv.html>`_.
The AppAPI dev setup steps listed :ref:`here <dev-setup>`.
Deploy daemons types
--------------------
There are two types of Deploy daemons that can be used for development and testing of ExApp:
1. ``manual_install``: This type of Deploy daemon is running manually in the host machine.
You can create it in AppAPI admin settings using template.
This is useful for development of ExApp, when you run your ExApp manually in the host.
2. ``docker_install``: This type of Deploy daemon is running in a Docker container.
Docker Socket Proxy
-------------------
For development and testing locally, the simplest is to use the `Nextcloud AppAPI DSP HTTP <https://github.com/cloud-py-api/docker-socket-proxy?tab=readme-ov-file#httplocal>`_.

View File

@@ -20,7 +20,7 @@ Lets go through the ExApp development steps briefly.
0. Setting up the development environment
-----------------------------------------
First of all, you need to have a Nextcloud dev setup, refer to :ref:`DevelopmentEnvironment` for more details.
First of all, you need to have a Nextcloud dev setup, refer to :ref:`dev-setup` for more details.
1. Starting from template
-------------------------

View File

@@ -10,7 +10,6 @@ grouped from other parts of documentation.
.. toctree::
:maxdepth: 2
DevelopmentEnvironment
ExAppDevelopmentSteps
ExAppOverview
ExAppLifecycle