generator-realtime
Advanced tools
Yeoman generator for AngularJS + Firebase, with a couple of extras.
angular-fire is included by default. A main firebase URL is set on $rootScope, and the $firebase service is injected into controllers.
A service called firesolver is included, which is a route resolver that plays nicely with $firebase and $firebaseSimpleAuth.
TODO - document this!
Classy is used for controllers, which look like this in generator-realtime:
'use strict'
angular.module('gentestApp').classy
.controller
name: 'MainCtrl'
inject: ['$scope', '$rootScope', '$firebase']
init: ->
# Bitcoin price "last" reference is on the $rootScope
bitcoinRef = new Firebase @$rootScope.firebaseURL
# Shorthand for @$scope.bitcoin is @$.bitcoin
@$.bitcoin = @$firebase bitcoinRef
Colors.css contains some nice-looking versions of default web colors. Just use color: $red instead of color: red
Animate.sass is the sass version of the popular Animate.css, and adds the ability to only import certain animations to cut down on size a bit. If you want to use an animation, make sure to turn it on first, like so:
$use-fadeInUp: true;
// bower:scss
// ... some bower stuff
// endbower
Make sure to do this before the bower:scss section
See the animate-sass settings file for a list of variable names.
Currently, this only supports coffeescript. Once the dust settles a little bit, I'll build out the javascript templates as well. Also, animate-sass and colors.scss are only really applicable if you're using sass.
And of course, feel free to send a pull request :)
Install generator-realtime:
npm install -g generator-realtime
Make a new directory, and cd into it:
mkdir my-new-project && cd $_
Run yo realtime, optionally passing an app name:
yo realtime [app-name]
Run grunt for building and grunt serve for preview
Available generators:
Note: Generators are to be run from the root directory of your app.
Sets up a new AngularJS app, generating all the boilerplate you need to get started. The app generator also optionally installs Bootstrap and additional AngularJS modules, such as angular-resource (installed by default).
Example:
yo realtime
Generates a controller and view, and configures a route in app/scripts/app.js connecting them.
Example:
yo realtime:route myroute
Produces app/scripts/controllers/myroute.js:
angular.module('myMod').controller('MyrouteCtrl', function ($scope) {
// ...
});
Produces app/views/myroute.html:
<p>This is the myroute view</p>
Explicitly provide route URI
Example:
yo realtime:route myRoute --uri=my/route
Produces controller and view as above and adds a route to app/scripts/app.js
with URI my/route
Resolve route with data from firebase and inject into controller
(not currently available for javascript)
Example:
yo realtime:route myRoute --resolve
Produces controller, view, and route as above, and adds a resolve function that attempts
to fetch data from firebase. If that data is found, it is injected into the generated controller.
If not, the route change fails and an error will be thrown on $rootScope called routeChangeError
Only allow authenticated users to access route
Example:
yo realtime:route myRoute --authenticated
Produces controller, view, and route as above, and adds a resolve function that ensures that the current user is authenticated. If the user is not logged in, the route change fails and an error will be thrown
on $rootScope called routeChangeError
All of the things
Example:
yo realtime:route myRoute --resolve --authenticated
Generates a controller in app/scripts/controllers.
Remembers if you asked to use Classy when scaffolding the app.
Example:
yo realtime:controller user
Produces app/scripts/controllers/user.js:
angular.module('myMod').controller('UserCtrl', function ($scope) {
// ...
});
Generates a directive in app/scripts/directives.
Example:
yo realtime:directive myDirective
Produces app/scripts/directives/myDirective.js:
angular.module('myMod').directive('myDirective', function () {
return {
template: '<div></div>',
restrict: 'E',
link: function postLink(scope, element, attrs) {
element.text('this is the myDirective directive');
}
};
});
Generates a filter in app/scripts/filters.
Example:
yo realtime:filter myFilter
Produces app/scripts/filters/myFilter.js:
angular.module('myMod').filter('myFilter', function () {
return function (input) {
return 'myFilter filter:' + input;
};
});
Generates an HTML view file in app/views.
Example:
yo realtime:view user
Produces app/views/user.html:
<p>This is the user view</p>
Generates an AngularJS service.
Example:
yo realtime:service myService
Produces app/scripts/services/myService.js:
angular.module('myMod').service('myService', function () {
// ...
});
You can also do yo realtime:factory, yo realtime:provider, yo realtime:value, and yo realtime:constant for other types of services.
Generates an AngularJS service decorator.
Example:
yo realtime:decorator serviceName
Produces app/scripts/decorators/serviceNameDecorator.js:
angular.module('myMod').config(function ($provide) {
$provide.decorator('serviceName', function ($delegate) {
// ...
return $delegate;
});
});
In general, these options can be applied to any generator, though they only affect generators that produce scripts.
For generators that output scripts, the --coffee option will output CoffeeScript instead of JavaScript.
For example:
yo realtime:controller user --coffee
Produces app/scripts/controller/user.coffee:
angular.module('myMod')
.controller 'UserCtrl', ($scope) ->
A project can mix CoffeScript and JavaScript files.
To output JavaScript files, even if CoffeeScript files exist (the default is to output CoffeeScript files if the generator finds any in the project), use --coffee=false.
Removed
Related Issue #452: This option has been removed from the generator. Initially it was needed as ngMin was not entirely stable. As it has matured, the need to keep separate versions of the script templates has led to extra complexity and maintenance of the generator. By removing these extra burdens, new features and bug fixes should be easier to implement. If you are dependent on this option, please take a look at ngMin and seriously consider implementing it in your own code. It will help reduce the amount of typing you have to do (and look through) as well as make your code cleaner to look at.
By default, generators produce unannotated code. Without annotations, AngularJS's DI system will break when minified. Typically, these annotations that make minification safe are added automatically at build-time, after application files are concatenated, but before they are minified. The annotations are important because minified code will rename variables, making it impossible for AngularJS to infer module names based solely on function parameters.
The recommended build process uses ngmin, a tool that automatically adds these annotations. However, if you'd rather not use ngmin, you have to add these annotations manually yourself. **One thing to note is that ngmin does not produce minsafe code for things that are not main level elements like controller, services, providers, etc.:
resolve: {
User: function(myService) {
return MyService();
}
}
will need to be manually done like so:
resolve: {
User: ['myService', function(myService) {
return MyService();
}]
}
By default, new scripts are added to the index.html file. However, this may not always be suitable. Some use cases:
To skip adding them to the index, pass in the skip-add argument:
yo realtime:service serviceName --skip-add
The following packages are always installed by the app generator:
The following additional modules are available as components on bower, and installable via bower install:
All of these can be updated with bower update as new versions of AngularJS are released.
Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.
You can change the app directory by adding a appPath property to bower.json. For instance, if you wanted to easily integrate with Express.js, you could add the following:
{
"name": "yo-test",
"version": "0.0.0",
...
"appPath": "public"
}
This will cause Yeoman-generated client-side files to be placed in public.
Running grunt test will run the unit tests with karma.
See the contributing docs
When submitting an issue, please follow the guidelines. Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.
When submitting a PR, make sure that the commit messages match the AngularJS conventions.
When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
When submitting a new feature, add tests that cover the feature.
FAQs
Yeoman generator for AngularJS + Firebase
The npm package generator-realtime receives a total of 4 weekly downloads. As such, generator-realtime popularity was classified as not popular.
We found that generator-realtime demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Research
A malicious npm campaign is targeting Ethereum developers by impersonating Hardhat plugins and the Nomic Foundation, stealing sensitive data like private keys.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.