___

Monitor Legislativo

Angular application to show all law-projects approved by the government of São José dos Campos.

In This Documentation

1. Getting Started
2. Gulp Tasks
3. File Structure
4. Scripts
5. License

Getting Started

Dependencies

Make sure these are installed first.

• Node.js
• Gulp

Quick Start

1. In bash/terminal/command line, cd into your project directory.
2. Run npm install -g yo bower grunt-cli gulp && npm install && bower install to install required dependencies.
3. When it's done installing, run one of the task runners to get going:

NPM scripts

npm run-script build to build an optimized version of your application in /dist npm run-script serve to launch a browser sync server on your source files npm run-script serve:dist to launch a server on your optimized application npm run-script test to launch your unit tests with Karma npm run-script test:auto to launch your unit tests with Karma in watch mode npm run-script protractor to launch your e2e tests with Protractor npm run-script protractor:dist to launch your e2e tests with Protractor on the dist files

Features included in the gulpfile

• useref : allow configuration of your files in comments of your HTML file
• ngAnnotate : convert simple injection to complete syntax to be minification proof
• uglify : optimize all your JavaScript
• csso : optimize all your CSS
• rev : add a hash in the file names to prevent browser cache problems
• watch : watch your source files and recompile them automatically
• jshint : JavaScript code linter
• imagemin : all your images will be optimized at build
• Unit test (karma) : out of the box unit test configuration with karma
• e2e test (protractor) : out of the box e2e test configuration with protractor
• browser sync : full-featured development web server with livereload and devices sync
• angular-templatecache : all HTML partials will be converted to JS to be bundled in the application

Frameworks used on this project:

AngularJS: HTML enhanced for web apps! https://angularjs.org/

Angular Material Design: The Angular reference implementation of the Google's Material Design specification. https://material.angularjs.org/#/

Sass (Node): Node.js binding to libsass, the C version of the popular stylesheet preprocessor, Sass. https://github.com/sass/node-sass

Jasmine: Behavior-Driven JavaScript. http://jasmine.github.io/

BrowserSync: Time-saving synchronised browser testing. http://browsersync.io/

GulpJS: The streaming build system. http://gulpjs.com/

Protractor: End to end test framework for AngularJS applications built on top of WebDriverJS. https://github.com/angular/protractor

Karma: Spectacular Test Runner for JavaScript. http://karma-runner.github.io/

File Structure

Best Practice Recommendations for Angular App Structure

The root directory generated for a app with name gulpAngular :

├──  src/
│   ├──  app/
│   │   ├──  components/
│   │   │   └──  navbar/
│   │   │   │   ├──  navbar.controller.js
│   │   │   │   └──  navbar.html
│   │   ├──  main/
│   │   │   ├──  main.controller.js
│   │   │   ├──  main.controller.spec.js
│   │   │   └──  main.html
│   │   └──  index.js
│   │   └──  index.(css|less|scss)
│   │   └──  vendor.(css|less|scss)
│   ├──  assets/
│   │   └──  images/
│   ├──  404.html
│   ├──  favico.ico
│   └──  index.html
├──  gulp/
├──  e2e/
├──  bower_components/
├──  nodes_modules/
├──  .bowerrc
├──  .editorconfig
├──  .gitignore
├──  .jshintrc
├──  bower.json
├──  gulpfile.js
├──  karma.conf.js
├──  package.json
├──  protractor.conf.js

License

Leis SJC is licensed under the MIT License. .