Starter Kit

Web project starter kit including modern (and stable) tools and workflow, best practices, base template and an exhaustive documentation.

Built on experience with large web projects, with architecture choices aiming for a clean, no-brainer development experience.

Generated using the angular-pro Yeoman generator.

Getting started

1. Install required tools gulp and bower:

npm install -g gulp bower

2. Install project tools, go to project folder:

npm install

3. Launch development server:

gulp serve

Project structure

gulp/                   individual gulp tasks
sources/                project source code
|- data/                other project data, will be copied as-is
|- fonts/               project fonts
|- images/              project images
|- libraries/           Bower dependencies
|- main/                app components
|  |- main.config.ts    app configuration code
|  |- main.constants.ts app configuration constants
|  |- main.module.ts    app module definition
|  |- main.routes.ts    app routes
|  |- main.run.ts       app entry point
|  |- main.wrappers.ts  AngularJS module wrappers for external libraries
|  |- main.scss         style entry point
|  |- helpers/          helper services
|  |- screens/          application screens
|  |- shell/            application shell
|  |- ui-components/    shared UI components
|  |- web-services/     web services
|  +- ...               additional components
|- translations/        translations files
+- index.html           html entry point
e2e/                    end-to-end tests
dist/                   compiled version
typings/                TypeScript definitions
reports/                test and coverage reports
gulpfile.config.js      gulp tasks configuration

Main gulp tasks

Tasks	Description
default	run clean, then build
serve	Launch a web server with live reload and API proxy, then open app in browser.
serve:dist	Launch a web server using dist files.
build	Build and optimize the current project, ready for deployment. This includes linting as well as image, script, stylesheet and HTML optimization and minification.
clean	Delete temporary files and dist files.
test	Launch unit tests using karma and jasmine.
test:auto	Launch karma server and launch unit tests after each change in project files.
protractor	Launch e2e tests using protractor.
tsd	Download and update all TypeScript definitions for Bower dependencies.

When building the application, you can specify the target environment using the flag --environment <name>.

The default build environment is production. See this documentation for more details about multiple build environments management.

You can disable opening automatically your default browser when using the serve commands by using the flag --skip-open.

Coding guides

• JavaScript
• TypeScript
• CSS
• HTML
• Unit tests
• End-to-end tests

Additional documentation

• Build environments
• i18n
• Proxy configuration
• All gulp tasks
• Updating dependencies

Languages

• TypeScript, JavaScript
• Sass, CSS
• Gettext (for translations)

Quality

• TSLint
• HTMLHint
• Unit tests (Jasmine)
• End-to-end tests (Protractor)

Development

• Automation with gulp
• Webpack build
• Development server with API proxy and live reload (BrowserSync)

Build

• JS+CSS+HTML bundling and minification (useref, uglify, html-minify, clean-css
• CSS browser support (autoprefixer)
• Images optimization (imagemin)
• Automatic angular module annotation (ngAnnotate)
• Asset revisionning (rev)

Libraries

• AngularJS
• Angular-gettext
• AngularUI Router
• UI Bootsrap
• Bootstrap
• Font Awesome
• Lodash

License

This starter kit is based on tooling from the gulp-angular Yeoman generator. Portions of project generator-gulp-angular are Copyright (c) 2014 Matthieu Lux & Mehdy Dara

The MIT License (MIT)

Copyright (c) 2015-2017 Thales Services SAS

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.