Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngx-rocket/starter-kit
:package: Angular 14+ starter kit for enterprise-grade projects
https://github.com/ngx-rocket/starter-kit
angular angular-cli bootstrap industrial ionic material ngx ngx-rocket rocket sass seed starter-kit typescript
Last synced: 26 days ago
JSON representation
:package: Angular 14+ starter kit for enterprise-grade projects
- Host: GitHub
- URL: https://github.com/ngx-rocket/starter-kit
- Owner: ngx-rocket
- Created: 2017-03-06T08:52:41.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-09-07T09:15:09.000Z (about 2 years ago)
- Last Synced: 2024-04-14T07:39:00.644Z (7 months ago)
- Topics: angular, angular-cli, bootstrap, industrial, ionic, material, ngx, ngx-rocket, rocket, sass, seed, starter-kit, typescript
- Language: TypeScript
- Homepage:
- Size: 992 KB
- Stars: 1,279
- Watchers: 77
- Forks: 647
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-angular - ngx-rocket - Angular 9+ starter kit for enterprise-grade projects. (Uncategorized / Uncategorized)
- angular-awesome - ngX Starter Kit - Rocket](https://github.com/ngx-rocket/generator-ngx-rocket), this starter kit includes **modern tools** and workflow based on angular-cli, **best practices** from the community, a **scalable base template** and a good learning base. This starter kit comes pre-equipped with **Bootstrat 4, Font Awesome, RxJS, ng-bootstrap, ngx-translate and Lodash**. The starter also includes a basic \*\*login screen, interceptors, guards etc. (`🎉 Using Starter Kits`)
README
# ngX Starter Kit
Web project starter kit including modern tools and workflow based on
[angular-cli](https://github.com/angular/angular-cli), best practices from the community, a scalable base template and
a good learning base.
Generated using [ngX-Rocket](https://github.com/ngx-rocket/generator-ngx-rocket).
### Benefits
- 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
# Getting started
1. Go to project folder and install dependencies:
```bash
npm install
```
2. Launch development server, and open `localhost:4200` in your browser:
```bash
npm start
```
# Project structure
```
dist/ compiled version
docs/ project docs and coding guides
e2e/ end-to-end tests
src/ 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 point
reports/ test and coverage reports
proxy.conf.js backend proxy configuration
```
# Main tasks
Task automation is based on [NPM scripts](https://docs.npmjs.com/misc/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](https://karma-runner.github.io) 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](http://www.protractortest.org)
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 ` (do not
forget to prepend `--` to pass arguments to npm scripts).
The default build environment is `prod`.
## Development server
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.
## Code scaffolding
Run `npm run generate -- component ` to generate a new component. You can also use
`npm run generate -- directive|pipe|service|class|module`.
If you have installed [angular-cli](https://github.com/angular/angular-cli) globally with `npm install -g @angular/cli`,
you can also use the command `ng generate` directly.
## Additional tools
Tasks are mostly based on the `angular-cli` tool. Use `ng help` to get more help or go check out the
[Angular-CLI README](https://github.com/angular/angular-cli).
# What's in the box
The app template is based on [HTML5](http://whatwg.org/html), [TypeScript](http://www.typescriptlang.org) and
[Sass](http://sass-lang.com). The translation files use the common [JSON](http://www.json.org) format.
#### Tools
Development, build and quality processes are based on [angular-cli](https://github.com/angular/angular-cli) and
[NPM scripts](https://docs.npmjs.com/misc/scripts), which includes:
- Optimized build and bundling process with [Webpack](https://webpack.github.io)
- [Development server](https://webpack.github.io/docs/webpack-dev-server.html) with backend proxy and live reload
- Cross-browser CSS with [autoprefixer](https://github.com/postcss/autoprefixer) and
[browserslist](https://github.com/ai/browserslist)
- Asset revisioning for [better cache management](https://webpack.github.io/docs/long-term-caching.html)
- Unit tests using [Jasmine](http://jasmine.github.io) and [Karma](https://karma-runner.github.io)
- End-to-end tests using [Protractor](https://github.com/angular/protractor)
- Static code analysis: [TSLint](https://github.com/palantir/tslint), [Codelyzer](https://github.com/mgechev/codelyzer),
[Stylelint](http://stylelint.io) and [HTMLHint](http://htmlhint.com/)
- Local knowledgebase server using [Hads](https://github.com/sinedied/hads)
- Automatic code formatting with [Prettier](https://prettier.io)
#### Libraries
- [Angular](https://angular.io)
- [Bootstrap](https://getbootstrap.com)
- [Font Awesome](http://fontawesome.io)
- [RxJS](http://reactivex.io/rxjs)
- [ng-bootstrap](https://ng-bootstrap.github.io)
- [ngx-translate](https://github.com/ngx-translate/core)
- [Lodash](https://lodash.com)
#### Coding guides
- [Angular](docs/coding-guides/angular.md)
- [TypeScript](docs/coding-guides/typescript.md)
- [Sass](docs/coding-guides/sass.md)
- [HTML](docs/coding-guides/html.md)
- [Unit tests](docs/coding-guides/unit-tests.md)
- [End-to-end tests](docs/coding-guides/e2e-tests.md)
#### Other documentation
- [I18n guide](docs/i18n.md)
- [Working behind a corporate proxy](docs/corporate-proxy.md)
- [Updating dependencies and tools](docs/updating.md)
- [Using a backend proxy for development](docs/backend-proxy.md)
- [Browser routing](docs/routing.md)
# License
[MIT](https://github.com/ngx-rocket/generator-ngx-rocket/blob/main/LICENSE)