generator-ngx-app
Advanced tools
Angular 2+ enterprise-grade project generator based on angular-cli with best practices from the community, a scalable starter template and a good learning base.
Web project starter kit including modern tools and workflow based on angular-cli, best practices from the community, a scalable base template and a good learning base.
See generated project example here.
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
npm install -g yo generator-ngx-app
yo ngx-app
dist/ compiled version
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.
| Tasks | Description |
|---|---|
| npm start | Run development server on http://localhost:4200/ |
| npm run build [-- --env=prod] | Lint code and build app for production in dist/ folder |
| 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 |
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:
FAQs
DEPRECATED: this package has been renamed to generator-ngx-rocket
We found that generator-ngx-app demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.