1
0
Fork 0
arangodb/Documentation/Books/Users/Foxx/Develop
Alan Plum a7a1ca2e00 More fixing of the queues. 2015-06-10 14:17:33 +02:00
..
ApiDocumentation.mdpp Added docs for API documentation. 2015-05-07 15:27:37 +02:00
Console.mdpp Changed some parts in the documentation of Foxx: 2015-03-13 16:22:27 +01:00
Controller.mdpp Fixed broken Link in Foxx/Develop/Controller 2015-05-13 09:52:40 +02:00
Debugging.mdpp Changed some parts in the documentation of Foxx: 2015-03-13 16:22:27 +01:00
Developmentmode.mdpp Fixed todos in Documentation 2015-03-13 16:57:28 +01:00
Folder.mdpp Changed some parts in the documentation of Foxx: 2015-03-13 16:22:27 +01:00
Manifest.mdpp Added docs for configuration. Fixes #1314. 2015-05-06 16:27:44 +02:00
Model.mdpp Implemented Repository lifecycle events. See #1257. 2015-03-25 10:35:18 +01:00
Queries.mdpp Changed some parts in the documentation of Foxx: 2015-03-13 16:22:27 +01:00
Queues.mdpp More fixing of the queues. 2015-06-10 14:17:33 +02:00
README.mdpp Changed some parts in the documentation of Foxx: 2015-03-13 16:22:27 +01:00
Repository.mdpp Fixed broken Links 2015-05-12 15:11:08 +02:00
Scripts.mdpp Updated scripts and queues docs. 2015-06-02 16:51:31 +02:00
Sessions.mdpp Corrected examples for Foxx Sessions 2015-05-07 20:04:51 +03:00

README.mdpp

!CHAPTER Develop your own Foxx

This chapter will explain to you how to write a Foxx on your own and use it to enhance the ArangoDB's functionality.
Be it a microservice, an API with a user interface or an internal library.

Before reading this chapter you should make sure to at least read one of the install sections beforehand to get a good staring point.
Recommended is the [generate](../Install/Generate.md) section to get started with your own Foxx, but you can also start with an existing one.

At first we will introduce the development mode and describe its side effects.
You can skip this section if you do not have access to the file system of ArangoDB as you will not get the benefits of this mode.
You will have to stick to the procedure described in [New Versions](../Production/Upgrade.md).

[Read More](Developmentmode.md)

Next you will learn about the debugging mechanisms if you have set a Foxx into development mode.
The app will return more debugging information in this mode like stacktraces.
In production mode stacktraces will be kept internally.

[Read More](Debugging.md)

If you want to get started with coding this is the section to begin with.
It will introduce the folder structure and describes where which files have to be located on server side.

[Read More](Folder.md)

Now we are entering the reference documentation of tools available in the Foxx framework.
The tools contain:

  * [Controller](../Develop/Controller.md)
  * [Setup & Teardown](../Develop/Scripts.md)
  * [Repository](../Develop/Repository.md)
  * [Model](../Develop/Model.md)
  * [Queries](../Develop/Queries.md)
  * [Background Tasks](../Develop/Queues.md)
  * [Console API](../Develop/Console.md)

Finally we want to apply some meta information to the Foxx.
How this is done is described in the [Metainformation](../Develop/Manifest.md) chapter.