Extensible Angular 4+ enterprise-grade project generator based on angular-cli with best practices from the community. Includes PWA and Cordova support, coding guides and more!
See generated project example here.
-
A complete starter template: example app structure tailored for scalability, with examples and boilerplate code for every common thing needed in enterprise projects, such as unit tests, routing, authentication, HTTPS service extensions, i18n support with dynamic language change and automatic user language detection...
-
Improved tooling: SCSS & HTML linting, stricter TSLint rules, markdown-based local wiki server for documentation, automated localizable strings extraction, corporate proxy support, Cordova integration
-
Extensive base documentation: coding guides for TypeScript/SCSS/HTML, Angular onboarding guide, corporate proxy and other tools configuration and usage...
-
Ready-to-use UI components: focus on your app, not on the stack! Choose between a Bootstrap 4 or Ionic based UI with nicely looking, responsive starter templates
-
Mobile app support: choose between a web app, a mobile app (using Cordova) or both using the same code base
-
API proxy example setup: develop and debug faster using any remote server
-
Generator output customization: with the provided add-on support, start multiple projects even faster by plugging in additions that fit your needs, such as your enterprise theme, SSO authentication, services integrations...
And there's even more! See What's in the box for more details.
Using ngX-Rocket CLI
- Install required tools:
npm install -g @ngx-rocket/cli- Create your application:
ngx new- Install required tools:
npm install -g yo generator-ngx-rocket- Create your application:
yo ngx-rocketdist/ app production build
docs/ project docs and coding guides
e2e/ end-to-end tests
src/ project source code
|- app/ app components
| |- core/ core module (singleton services and single-use components)
| |- shared/ shared module (common 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 point
reports/ test and coverage reports
proxy.conf.js backend proxy configuration
Task automation is based on NPM scripts.
| Task | Description |
|---|---|
npm start |
Run development server on http://localhost:4200/ |
npm run build [-- --env=prod] |
Lint code and build web app for production (with AOT) in dist/ |
npm test |
Run unit tests via Karma in watch mode |
npm run test:ci |
Lint code and run unit tests once for continuous integration |
npm run e2e |
Run e2e tests using Protractor |
npm run lint |
Lint code |
npm run translations:extract |
Extract strings from code and templates to src/app/translations/template.json |
npm run docs |
Display project documentation |
Additional tasks for Cordova-based projects:
| Task | Description |
|---|---|
npm run cordova:prepare |
Prepare for building mobile app (restore Cordova platforms and plugins) |
npm run cordova:run <ios/android> [--device] |
Run app on target platform device or simulator |
npm run cordova:build [-- --env=prod] |
Build mobile app for production in dist/ folder |
npm run cordova:clean |
Removes www/, platforms/ and plugins/ folders |
When building the application, you can specify the target environment using the additional flag --env <name> (do not
forget to prepend -- to pass arguments to npm scripts).
The default build environment is prod.
Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change
any of the source files.
You should not use ng serve directly, as it does not use the backend proxy configuration by default.
Run npm run generate -- component <name> to generate a new component. You can also use
npm run generate -- directive|pipe|service|class|module.
If you have installed angular-cli globally with npm install -g @angular/cli,
you can also use the command ng generate directly.
The app template is based on HTML5, TypeScript and Sass. The translation files use the common JSON format.
Development, build and quality processes are based on angular-cli and NPM scripts, which includes:
- Optimized build and bundling process with Webpack
- Development server with backend proxy and live reload
- Cross-browser CSS with autoprefixer and browserslist
- Asset revisioning for better cache management
- Unit tests using Jasmine and Karma
- End-to-end tests using Protractor
- Static code analysis: TSLint, Codelyzer, Stylelint and HTMLHint
- Local knowledgebase server using Hads
Progressive Web App (PWA) support provided by @angular/service-worker.
Native mobile application bundling is based on Cordova. Alternative enhanced web views are also supported:
- Angular
- RxJS
- ngx-translate
- Lodash
- UI based on:
- Bootstrap
- Ionic: