steeu / generator-wakanda-project

yeoman wakanda project generator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

generator-wakanda-project

MIT Licensed NPM version Build Status

Wakanda® and 4D® are registered trademarks of 4D SAS in France and/or other countries. All other names mentioned may be trademarks or registered trademarks of their respective owners.

Wakanda Project Yeoman generator

About

Wakanda Server and WakandaDB integrate an HTTP server and a JavaScript engine on top of a fast NoSQL Object datastore to creates an unbeatable combination for accessing your relational data quickly with a strong business logic applied.

This unoficial Yeoman generator creates Wakanda projects and solutions you can then edit from any dev tools, and provides a Grunt serve task to launch them on Wakanda server.

How to install

Install npm

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository, so first:

Super easy npm install

Install Yeoman

Next, you only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension. In the Wakanda serie, you might also be interested by the Wakanda Extension and Wakanda Widget generators.

To install the Wakanda Project generator from npm, run:

npm install -g generator-wakanda-project

How to use

Project generator

This generator will create a project and a solution to run it To Initiate the generator, do:

yo wakanda-project [appName]

Serve Task

The "serve" thsk will launch the solution on the Wakanda Server and run the "open" task. To run it you'll do:

grunt serve

Note that the "serve" task flags are all sent to the "open" task it invokes. You can then do directly:

grunt serve --catalog

Open Task

The "open" will as expected open an URL in the browser that, from the generated Gruntfile.js will be selected to be "Google Chrome" (The goal is to be used in combination with "google-chrome-reload" and "watch"). This option is easy to change in Gruntfile.js.

Show the project catalog [JSON]

grunt open --catalog

Show a Dataclass description [JSON]

Shows the description of its attributes and methods

grunt open --class=Product

Show data objects from a specific Dataclass [JSON]

grunt open --data=Product

TODO

  • Find better way to make open not stop the server using the grunt-wakanda plugin
  • Make Grunt work with multiple projects
  • Make Wakanda server parameters work to handle the debug mode (using grunt-wakanda)
  • Watch Wakanda server files and reload when required with via 'grunt-reload-chrome'
  • Make unit tests work correctly handle withArgs() and withPrompt()

License

The MIT License

Copyright (c) 2014 Alexandre Morgaut.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

yeoman wakanda project generator


Languages

Language:JavaScript 97.3%Language:HTML 2.7%