https://github.com/arangodb/foxx-apps

List of all public FOXX Applications for ArangoDB
https://github.com/arangodb/foxx-apps

Last synced: 29 days ago
JSON representation

List of all public FOXX Applications for ArangoDB

• Host: GitHub
• URL: https://github.com/arangodb/foxx-apps
• Owner: arangodb
• License: apache-2.0
• Created: 2013-09-26T09:41:14.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-02-12T15:02:05.000Z (almost 2 years ago)
• Last Synced: 2025-01-11T16:24:45.855Z (10 months ago)
• Size: 107 KB
• Stars: 37
• Watchers: 61
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Foxx applications

=================

Foxx is an easy way to create APIs and simple web applications from

within ArangoDB. It is inspired by Sinatra, the classy Ruby web

framework.

If you have created a nice Foxx application and you want to share it with

the community out there, clone this repository, add a short description

to the "applications" folder and issue a pull request.

"hello-foxx" is the hello world example for Foxx. Its 

[description file](https://github.com/arangodb/foxx-apps/blob/master/applications/hello-foxx.json)

can be found in the applications folder.

    {

      "description": "This is 'Hallo World' for ArangoDB Foxx.",

      "author": "Frank Celler",

      "versions": {

        "1.2.0" : { "type": "github", "location": "fceller/hello-foxx", "tag": "v1.2.0" }

      }

    }

The description file is a JSON document with the attributes:

* *description*: a short description of the application

* *author*: the name of the author, an email address, or a twitter handle

* *versions*: a list of available versions

In order to install this application into your local ArangoDB

installation, you can use the foxx-manager like this

    foxx-manager install hello-foxx /hello

This will download the application into your local installation of

ArangoDB (which must be up and running) and mount it under the path

"/hello".

If you now visit

    http://localhost:8529/hello

you should see a nice fox.