An upgradable development workflow library built on top of Gulp and focused on AngularJS components and applications.
ng-factory is based on best practices and covers the whole development lifecycle :
- Developement : code quality, preprocessors...
- Build : minification, concat, inject...
- Documentation : README + HTML doc & examples...
- Publication : TRAVIS CI integration, releases branches...
You can customize the README by adding a docs/README.tpl.md. This is a nunjucks template and it extends the default ng-factory template.
Add examples in the docs/examples folder, with a subfolder for each example.
Each example can have a single HTML file and any number of CSS, SCSS... and javascript files.
- signup to travis-ci.com
- activate your repository
- signup to codeclimate.com
- activate your repository
- add the token to
.travis.yml
For the sake of clarity and coherence
- Main ng-factoty tasks are in the tasks folder
- Template files are in the templates folder
- Utility transforms are in the transforms folder
Task name example : ng-factory:src/jshint.
ng-factoryis the namespacesrc/jshintthe targeted task
Jshint the sources
Jshint the tests
Bypass gulp plugins directly using the official node lib to to the work.
The pages are highly customizable. The pages templating is provided by (Nunjucks)[mozilla.github.io/nunjucks/].
We integrate a default page with the factory but you can change everything if you please.
The basic pages generation workflow is copy every thing to the .tmp/docs folder and generate what you need to output in the pages folder.
ng-factory/templates/pages/index.nunjucks.html is the default template file.
[...] More documentation here [...]
By extending the {% extends "views/base.nunjucks.html" %} default template you can customize different blocks.
Note: you can use {{ super() }} to render parent blocks
- ng-factory/templates/pages/views/base.nunjucks.html
- head for the
<head>content - body for the
<body>content - foot fot the "
<foot>" content (what comes after the content into the body)
- head for the
-
ng-factory/templates/pages/views/includes/head.nunjucks.html
- headLinks for the css scripts at the end of the
<head>tag
- headLinks for the css scripts at the end of the
-
ng-factory/templates/pages/views/includes/foot.nunjucks.html
- footScripts for the js scripts at the end of the
<body>tag
- footScripts for the js scripts at the end of the
[...] More documentation here [...]