repasse-client

FrontEnd do projeto repasse.

In This Documentation

• Getting Started
  • Dependencies
• Quick Start
• Gulp tasks
• Features included in the gulpfile
  • Directory structure
• Changelog
• Contributing
• License

Getting Started

Dependencies

Make sure these are installed first.

• Node.js It's recommended to use NVM on linux and Chocolatey on Windows.

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:

Gulp tasks

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

More information on the gulp tasks in this README.md.

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

Directory 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

Changelog

All changes listed in the GitHub releases

Contributing

Guidelines

License

CC0 1.0 Universal