Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaumesegarra/generator-nww
Yeoman generator for NW.js, Angular, Jquery, [Bootstrap]
https://github.com/jaumesegarra/generator-nww
angular bootstrap jquery nwjs yeoman-generator
Last synced: 13 days ago
JSON representation
Yeoman generator for NW.js, Angular, Jquery, [Bootstrap]
- Host: GitHub
- URL: https://github.com/jaumesegarra/generator-nww
- Owner: jaumesegarra
- License: mit
- Created: 2017-09-15T17:05:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-24T11:55:42.000Z (over 7 years ago)
- Last Synced: 2024-11-19T14:56:39.503Z (about 1 month ago)
- Topics: angular, bootstrap, jquery, nwjs, yeoman-generator
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
generator-nww
================================
>A NW.JS (Node-Webkit) yeoman generator for NW.js, [Bootstrap+Jquery] and Angular
Yeoman generator for NW.js (Node-Webkit). This generator is a fork of generator-wean but without express and with improved features
As well for [slush](https://www.npmjs.com/package/slush-nww)
## Requirements
* [Node](https://nodejs.org)
* [Grunt](http://gruntjs.com/)
* [Yeoman](http://yeoman.io/)
* [Bower](http://bower.io/)
## Installation
To install the generator:
`npm install -g generator-nww`
You need to have node, grunt, yo and bower installed globally before running the command. Therefore download node from the link and run:
`npm install -g yo grunt bower`
### Scaffold an application
Scaffolding a NWW application works like every other Yeoman generator. If you have the generator installed, cd to an empty project directory and run:
`yo nww`
Interact with Yeoman to create the application.
## Developing
NWW allows you to create a new controller, factory, service or provider, just run `yo nww:controller homeCtrl` for example. Generated files will be in js folder.
Also you can use sass in your project. For convert scss to css file you must run `grunt watch`, sure that file is in scss folder. Scss files also be coverted to css before building app.
## Running
The application will scaffold completely while generating but there are chances that npm and bower installation might not be successful, probably because of unstable internet connection as npm needs to download NW.js which is > 30mb therefore the application will not run.
If such case occurs, run `npm install` and `sudo bower install --allow-root` to complete the installation.
To run the NW application:
`grunt` or `grunt run`
## Building
Another amazing feature of this generator is that you can build to all mac, windows, and linux using a simple command. If you think you app is ready for consumption, run:
`grunt build:{platform}`
The platform placeholder can be win, mac, linux and all. Choose all to build for all the platforms. If the parameters are not specified, it builds for the current OS.
eg:
`grunt build`
`grunt build:mac`
`grunt build:win`
`grunt build:linux`
`grunt build:all`
## How about Icons
Yeah. Icons. Icons are very easy to setup for mac and windows. Copy the `.icns` and `.ico` version of your icon named `app-icon` to the root of the project before building and that is all.
## Contributing
I will really appreciate any contributions to this project (no matter how little). Please use the [guidelines](https://github.com/christiannwamba/generator-wean/blob/master/CONTRIBUTING.md)
## Thanks
* [Arvind Ravulavaru](https://github.com/arvindr21/slush-wean) (Inspiration)
* [elmuchaco](http://stackoverflow.com/a/22476910)
* [christiannwamba](https://github.com/christiannwamba)
## License
The MIT License
Copyright (c) 2017, Jaume Segarra
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.