1
0
Fork 0
arangodb/Documentation/Books/Users/Foxx/Develop/Developmentmode.mdpp

52 lines
2.9 KiB
Plaintext

!CHAPTER Application Development Mode
This chapter describes the development mode for Foxx applications.
It is only useful if you have write access to the files in ArangoDB's application folder.
The folder is located at `TODO!` by default and can be reconfigured using the startup option `--javascript.app-path`.
If you do not have access to this folder, e.g. using a hosted service like [myArangoDB](https://myarangodb.com/), you cannot make use of this feature.
You will have to stick to the procedure described in [New Versions](../Production/Upgrade).
<div class="versionDifference">
Before 2.5 the startup option `--javascript.dev-app-path` was required for the development mode.
This caused a lot of confusion and introduced problems when moving from development to production.
So we decided to unify both app paths and activate development mode for specific Apps during runtime.
The `--javascript.dev-app-path` parameter is not having any effect any more.
</div>
!SECTION Activation
Activating the development mode is done with a single command:
unix> foxx-manager development /example
Activated development mode for Application hello-foxx version 1.5.0 on mount point /example
Now the app will *list* itself as a development app:
unix> foxx-manager list
Mount Name Author Description Version Development
--------------------- ------------ -------------- ----------------------------------------------- -------- ------------
/_admin/aardvark aardvark ArangoDB GmbH ArangoDB Admin Web Interface 1.0 false
/_api/gharial gharial ArangoDB GmbH ArangoDB Graph Module 0.1 false
/_system/cerberus cerberus ArangoDB GmbH Password Manager 0.0.1 false
/_system/sessions sessions ArangoDB GmbH Session storage for Foxx. 0.1 false
/_system/simple-auth simple-auth ArangoDB GmbH Simple password-based authentication for Foxx. 0.1 false
/example hello-foxx Frank Celler This is 'Hello World' for ArangoDB Foxx. 1.5.0 true
--------------------- ------------ -------------- ----------------------------------------------- -------- ------------
6 application(s) found
!SECTION Effects
For a Foxx application in development mode the following effects apply:
<dl>
<dt>Reload on request</dt>
<dl>
Whenever a request is routed to this application it's source is reloaded.
This means all requests are slightly slower than in production mode.
But you will get immediate live updates on your code changes.
</dl>
<dt>Exposed Debugging information</dt>
<dl>
This application will deliver error messages and stack traces to requesting client.
For more information see the [Debugging](Debugging.md) section.
</dl>
</dl>