foxxy : create your app with ArangoDB Foxx RiotJS UIKIT3 Brunch Yarn
Switch branches/tags
Clone or download
Olivier BONNAURE
Olivier BONNAURE Documentation fix
Latest commit 26a24e0 Nov 5, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Documentation fix Nov 5, 2018
templates setPerPage Fix Nov 5, 2018
.gitignore I18n WIP Dec 17, 2017
README.md Documentation fix Nov 5, 2018
Roadmap.md 0.5.7 Jan 18, 2018
changelog.md New float type May 30, 2018
package.json Documentation fix Nov 5, 2018

README.md

Gitter

foxxy

foxxy is a simple tool which help you starting with your single page application using ArangoDB / Foxx for backend and API, riotjs for views and brunch to build your assets.

https://foxxy.ovh

Prerequisite

Installation

$ npm install foxxy -g

Configurating application

$ foxxy new demo_app --database demoapp
$ cd demo_app/
$ yarn install

Symlink to your foxx folder

To simplify your work, create a symlink from your arangodb foxx folder to your app foxx folder

Creating a new application

First create a database called demoapp within ArangoDB Web UI

$ foxxy new demo_app --database demoapp

This will create a new folder named 'demo_app' which will contain everything you need to start your new app.

Install depedencies

$ cd demo_app

$ npm install

Creating your first CRUD

$ foxxy g crud post

Please use singular for your model name.

Ok now you have your first CRUD created.

Compile the app

Dev mode

$ yarn start will start the live reloader and a server.

Deployment

To deploy your app, you'll need ruby and mina gem

Check config/deploy.rb and adapt it to your needs.

Then run : $ mina deploy

It will compile assets for production env and deploy code (app & Foxx services)

Todo

  • Use jwtTokens to avoid nginx _db mounting point