solisoft / foxxy Goto Github PK

View Code? Open in Web Editor NEW

47.0 5.0 8.0 1.07 MB

foxxy : create your app with ArangoDB Foxx RiotJS UIKIT3 Brunch Yarn

Home Page: https://foxxy.ovh

JavaScript 88.90% Ruby 2.50% HTML 3.30% CSS 5.30%

foxx arangodb riotjs crud

foxxy's Introduction

Please check https://fasty.ovh

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

ArangoDB >= 3.1
Node.js
Ruby (for deployment purpose)
yarn https://yarnpkg.com/en/docs/install

Installation

$ npm install foxxy -g

Configurating application

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

You'll also need to have a ~/.foxxrc file with this content :

[server.foxxy]
url=http://localhost:8529
username=root
password=

Of course update params if needed.

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.

Upgrading the service

To update your arangodb Foxx service run :

$ foxxy upgrade or $foxxy upgrade <your_service>

With no arguments, all the service aill be refreshed.

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)

foxxy's People

Contributors

Stargazers

Watchers

Forkers

davidoster hugomartin lssno dwba hallicarnassus gorilux fairhopeweb

foxxy's Issues

New SubModel fix has broken the foxxy generator.

Hello, just updated to your latest release and when creating a fresh project and have the following issues:

foxxy g crud user results in the following error:

fs.js:660
return binding.open(pathModule.toNamespacedPath(path),
^

Error: ENOENT: no such file or directory, open '/Users/smstewa5/Development/CerebroNG/foxx/cruds/APP/models/reports.js'
at Object.fs.openSync (fs.js:660:18)
at Object.fs.writeFileSync (fs.js:1319:33)
at copyFileSync (/Users/smstewa5/.config/yarn/global/node_modules/foxxy/bin/foxxy:16:6)
at /Users/smstewa5/.config/yarn/global/node_modules/foxxy/bin/foxxy:178:11
at ChildProcess.exithandler (child_process.js:265:7)
at ChildProcess.emit (events.js:180:13)
at maybeClose (internal/child_process.js:936:16)
at Socket.stream.socket.on (internal/child_process.js:353:11)
at Socket.emit (events.js:180:13)
at Pipe._handle.close [as _onclose] (net.js:541:12)

Also, unsurprisingly the UI page doesn't load correctly

SyntaxError: missing ) after argument list[Learn More] js.js:428:8
[Show/hide message details.] Error: Cannot find module 'js/common.js' from '/' vendors.js:61:11
require
http://localhost:3333/js/vendors.js:61:11

http://localhost:3333/:59:20

FYI I am using the new arangoDB 3.4 RC1 but this seems to be a path error in the generator

Model with collection relationship

Hi,

First, thanks for your framework ! I success to install and play with it
in documentation on your site, you explain creating a model with :
`
// { r: new_row, c: classname, n: name/id, t: type, j: joi validation, l: label, d: data list }

fields = [
{ r: true, c: "1-1", n: "title", t: "string", j: joi.string().required(), l: "Title" },
{ r: true, c: "1-2", n: "date", t: "date", j: joi.string().required(), l: "Publishing Date" },
{ r: false, c: "1-2", n: "draft", t: "list", j: joi.string().required(), l: "Draft?", d: [["y", "Yes"], ["n", "No"]] },
{ r: true, c: "1-1", n: "text", t: "text", j: joi.string().required(), l: "Text"}
]`

But could you give us an example for creating relationship with an another collection. By example adding a user_id in post collection.

Thanks in advance
Rodmar