https://github.com/solisoft/foxxy

foxxy : create your app with ArangoDB Foxx RiotJS UIKIT3 Brunch Yarn
https://github.com/solisoft/foxxy

arangodb crud foxx riotjs

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/solisoft/foxxy
• Owner: solisoft
• Created: 2016-08-09T07:31:41.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-08-10T21:46:58.000Z (over 3 years ago)
• Last Synced: 2024-11-11T11:53:10.608Z (2 months ago)
• Topics: arangodb, crud, foxx, riotjs
• Language: JavaScript
• Homepage: https://foxxy.ovh
• Size: 1.04 MB
• Stars: 47
• Watchers: 5
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md

Awesome Lists containing this project

README

        

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/solisoft/foxxy)

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 `

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)