Repository files navigation

Web project starter kit including modern tools and workflow based onangular-cli, best practices from the community, a scalable base template anda good learning base.

Generated usingngX-Rocket.

• Quickstart a project in seconds and focus on features, not on frameworks or tools

• Industrial-grade tools, ready for usage in a continuous integration environment and DevOps

• Scalable architecture with base app template including example components, services and tests

1. Go to project folder and install dependencies:

npm install

2. Launch development server, and openlocalhost:4200 in your browser:

npm start

dist/                        compiled versiondocs/                        project docs and coding guidese2e/                         end-to-end testssrc/                         project source code|- app/                      app components|  |- @shared/               shared module (common services, components, directives and pipes)|  |- app.component.*        app root component (shell)|  |- app.module.ts          app root module definition|  |- app-routing.module.ts  app routes|  +- ...                    additional modules and components|- assets/                   app assets (images, fonts, sounds...)|- environments/             values for various build environments|- theme/                    app global scss variables and theme|- translations/             translations files|- index.html                html entry point|- main.scss                 global style entry point|- main.ts                   app entry point|- polyfills.ts              polyfills needed by Angular+- test.ts                   unit tests entry pointreports/                     test and coverage reportsproxy.conf.js                backend proxy configuration

Task automation is based onNPM scripts.

When building the application, you can specify the target environment using the additional flag--env <name> (do notforget to prepend-- to pass arguments to npm scripts).

The default build environment isprod.

Runnpm start for a dev server. Navigate tohttp://localhost:4200/. The app will automatically reload if you changeany of the source files.You should not useng serve directly, as it does not use the backend proxy configuration by default.

Runnpm run generate -- component <name> to generate a new component. You can also usenpm run generate -- directive|pipe|service|class|module.

If you have installedangular-cli globally withnpm install -g @angular/cli,you can also use the commandng generate directly.

Tasks are mostly based on theangular-cli tool. Useng help to get more help or go check out theAngular-CLI README.

The app template is based onHTML5,TypeScript andSass. The translation files use the commonJSON format.

Development, build and quality processes are based onangular-cli andNPM scripts, which includes:

• Optimized build and bundling process withWebpack
• Development server with backend proxy and live reload
• Cross-browser CSS withautoprefixer andbrowserslist
• Asset revisioning forbetter cache management
• Unit tests usingJasmine andKarma
• End-to-end tests usingProtractor
• Static code analysis:TSLint,Codelyzer,Stylelint andHTMLHint
• Local knowledgebase server usingHads
• Automatic code formatting withPrettier

• Angular
• Bootstrap
• Font Awesome
• RxJS
• ng-bootstrap
• ngx-translate
• Lodash

• Angular
• TypeScript
• Sass
• HTML
• Unit tests
• End-to-end tests

• I18n guide
• Working behind a corporate proxy
• Updating dependencies and tools
• Using a backend proxy for development
• Browser routing

MIT