Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/molekilla/rutha
Rutha - HapiJS AngularJS Stack
https://github.com/molekilla/rutha
angular frontend hapi
Last synced: about 1 month ago
JSON representation
Rutha - HapiJS AngularJS Stack
- Host: GitHub
- URL: https://github.com/molekilla/rutha
- Owner: molekilla
- License: mit
- Created: 2014-07-25T00:46:36.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-24T01:17:44.000Z (over 8 years ago)
- Last Synced: 2024-04-10T02:56:46.978Z (9 months ago)
- Topics: angular, frontend, hapi
- Language: JavaScript
- Homepage:
- Size: 10.8 MB
- Stars: 48
- Watchers: 9
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: license
Awesome Lists containing this project
README
# rutha
## an hapi/angular frontend and service stack
For an ES6 version: Take a look at [rutha 2016](https://github.com/molekilla/rutha-2016)
[](https://travis-ci.org/molekilla/rutha)
Pure pragmatic NodeJS stack
#### Changelog: [changelog](changelog.md)
#### Last update: 2.1.0
#### Docs:
* [rutha - A Hapi and Angular boilerplate stack - English](http://yoworkeo.blogspot.com/2015/02/rutha-hapi-and-angular-boilerplate-stack.html)
* [Hapi View Partials - Spanish](http://yoworkeo.blogspot.com/2014/08/hapijs-view-partials-con-underscorejs.html)
* [Hapi REST Authentication - Spanish](http://yoworkeo.blogspot.com/2014/08/hapijs-autenticacion-rest-con-hapi-auth.html)
* [Hapi Tutorials](http://hapijs.com/tutorials)
* [BabelJS: Learn ES6](https://babeljs.io/docs/learn-es6/)
* [ECMAScript6 by Luke Hoban](https://github.com/lukehoban/es6features)
* [Typescript](http://www.typescriptlang.org/)
* [Taming Angular 1.3 forms by Year of Moo](http://www.yearofmoo.com/2014/09/taming-forms-in-angularjs-1-3.html#html5-validators-and-parse-errors)
* [Jasmine BDD Introduction](http://jasmine.github.io/2.2/introduction.html)
### Main features ###
* **Rule Them All with a single environment**: Both development and production environment are the same. We concat, annotate, mix some ingredients and offer you the same production environment for development.
* **AngularJS 1.5.x**
* **Hapi 13.0.0**
* **Jasmine NPM**
* **Ionic**: Try [rutha-ionic](https://github.com/molekilla/rutha-ionic)
### Additional features
* **Grunt JIT**: Is JIT for Grunt. No more waits.
* **Underscore for frontend server side templates**: To avoid issues with AngularJS.
* [Grunt ngAnnotate](https://github.com/mzgol/grunt-ng-annotate)
* [Grunt Angular Templates](https://github.com/ericclemmons/grunt-angular-templates)
* **Specs and Functional Tests (Frontend)**: Based partially on [year of moo](http://www.yearofmoo.com/2013/01/full-spectrum-testing-with-angularjs-and-karma.html)
* **Visionmedia/debug** [module](https://github.com/visionmedia/debug) by default
* [Chris Sevilleja's 'Easy Node authentication' local and facebook sample code for HapiJS](http://scotch.io/tutorials/javascript/easy-node-authentication-setup-and-local)
* Basic cssmin task
* `grunt-nsp` support
* [Istanbul code coverage support](http://gotwarlost.github.io/istanbul/)
* Uses canned responses / server mocks / nobackend inspired by Euge's [canned responses](https://github.com/euge/canned-responses)
* [Hapi Swagger](https://github.com/glennjones/hapi-swagger)
* [Grunt JSDoc3](https://github.com/krampstudio/grunt-jsdoc)
## Installing
1. Clone repo
2. Rename text containing `rutha` to `your_app_name`
3. Be sure to have node 4.5.0 or greater (e.g. nvm use 4.5.0)
4. Run `npm install grunt-cli -g`
5. Change dir to ui and run `npm install` and then `bower install`
6. Open a new tab and change dir to service and run `npm install`
### Grunt Help (Service) ###
* `npm start`: Serves API service
* `npm test`: Runs Jasmine NPM specs
* `npm run nsp`: Verifies modules that contains security issues
* `grunt migrate:create [--name]`: Creates a migration task. Args: --name: migration name (optional)
* `grunt migrate:up [--revision]`: Migrates up. Args: --revision: revision name (optional)
* `grunt migrate:down [--revision]`: Migrates down. Args: --revision: revision name (optional)
* `grunt docs`: Builds jsdoc3 documentation.
## Grunt Help - Frontend tasks
* `npm start`: Serves frontend
* `npm test`: Runs Jasmine NPM specs
* `npm run nsp`: Verifies modules that contains security issues
* `grunt test`: Runs E2E/Functional tests (Angular)
* `grunt build`: Prepares UI assets
* `grunt stagelocal`: Provisions Vagrant VM
* `grunt staging`: Provisions staging
* `grunt deploy`: Provisions production
* `grunt jshinting`: Verifies javascript using jshint
### About Angular Tests
`ui/src/test/lib` contains libs require for testing. Scope.SafeApply can be added as optional (see yearofmoo blog post)
### Nginx routes (Optional) ###
```
server {
# simple reverse-proxy for Rutha (Very useful!)
listen 80;
server_name localhost;
access_log dev.log;
#error_page http://here;
location /api {
proxy_pass http://127.0.0.1:3002;
proxy_redirect default;
proxy_set_header Host $host;
}
location / {
proxy_pass http://127.0.0.1:3005;
proxy_redirect default;
proxy_set_header Host $host;
}
}
```
## Ansible deploy
### Deploying rutha apps with rutha_deploy ##
1. Run `grunt build` to generate frontend assets
2. Add zip file to commit e.g. git add releases/v0.1.0.zip.
3. In rutha-deploy, configure group_vars with your settings
```ruby
# devops
domain: disrupting_app.com
ssl_name: disrupting_app
# rutha
app_name: disrupting_app
app_repo: [email protected]:molekilla/rutha.git
app_branch: release0.1.0
app_version: v0.1.0
app_env:
NODE_ENV: production
```
4. Add hosts to /etc/ansible/hosts
5. Enable host in ui/Gruntfile.js by adding it to deploySettings.
6. Configure cloud / server with SSH key to get repo (or customize rutha-deploy to fetch from somewhere else).
7. Run `grunt deploy`
### Deploying rutha frontend app
1. Run `grunt build` to generate frontend assets
2. Add zip file to commit e.g. git add releases/v0.1.0.zip (or customize rutha-deploy to fetch from somewhere else).
3. In your devops workflow, unpack zip and run ui/lib/hapi/index.js
### Deploying rutha service app
1. Copy service directory or get from repo
3. In your devops workflow, run service/lib/hapi/index.js
### Maintainers, notes ###
Rogelio Morrell C.
### Disclaimer ###
Feel free to fork.