{"id":15819925,"url":"https://github.com/samprof/ngx-rocket-starter-kit","last_synced_at":"2025-04-01T05:54:54.956Z","repository":{"id":96418281,"uuid":"293021052","full_name":"SamProf/ngx-rocket-starter-kit","owner":"SamProf","description":null,"archived":false,"fork":false,"pushed_at":"2020-09-05T06:54:17.000Z","size":116,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-12T07:01:57.912Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SamProf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-05T06:54:13.000Z","updated_at":"2020-09-27T21:30:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"b4456974-6762-4bb1-a829-0cac6e928604","html_url":"https://github.com/SamProf/ngx-rocket-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"ngx-rocket/starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamProf%2Fngx-rocket-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamProf%2Fngx-rocket-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamProf%2Fngx-rocket-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamProf%2Fngx-rocket-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SamProf","download_url":"https://codeload.github.com/SamProf/ngx-rocket-starter-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246591782,"owners_count":20801986,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-05T07:00:53.037Z","updated_at":"2025-04-01T05:54:54.934Z","avatar_url":"https://github.com/SamProf.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ngX Starter Kit\n\nWeb project starter kit including modern tools and workflow based on\n[angular-cli](https://github.com/angular/angular-cli), best practices from the community, a scalable base template and\na good learning base.\n\nGenerated using [ngX-Rocket](https://github.com/ngx-rocket/generator-ngx-rocket).\n\n### Benefits\n\n- Quickstart a project in seconds and focus on features, not on frameworks or tools\n\n- Industrial-grade tools, ready for usage in a continuous integration environment and DevOps\n\n- Scalable architecture with base app template including example components, services and tests\n\n# Getting started\n\n1. Go to project folder and install dependencies:\n ```bash\n npm install\n ```\n \n2. Launch development server, and open `localhost:4200` in your browser:\n ```bash\n npm start\n ```\n \n# Project structure\n\n```\ndist/                        compiled version\ndocs/                        project docs and coding guides\ne2e/                         end-to-end tests\nsrc/                         project source code\n|- app/                      app components\n|  |- @core/                 core module (singleton services and single-use components)\n|  |- @shared/               shared module  (common components, directives and pipes)\n|  |- app.component.*        app root component (shell)\n|  |- app.module.ts          app root module definition\n|  |- app-routing.module.ts  app routes\n|  +- ...                    additional modules and components\n|- assets/                   app assets (images, fonts, sounds...)\n|- environments/             values for various build environments\n|- theme/                    app global scss variables and theme\n|- translations/             translations files\n|- index.html                html entry point\n|- main.scss                 global style entry point\n|- main.ts                   app entry point\n|- polyfills.ts              polyfills needed by Angular\n+- test.ts                   unit tests entry point\nreports/                     test and coverage reports\nproxy.conf.js                backend proxy configuration\n```\n\n# Main tasks\n\nTask automation is based on [NPM scripts](https://docs.npmjs.com/misc/scripts).\n\nTasks                         | Description\n------------------------------|---------------------------------------------------------------------------------------\nnpm start                     | Run development server on `http://localhost:4200/`\nnpm run build [-- --env=prod] | Lint code and build app for production in `dist/` folder\nnpm test                      | Run unit tests via [Karma](https://karma-runner.github.io) in watch mode\nnpm run test:ci               | Lint code and run unit tests once for continuous integration\nnpm run e2e                   | Run e2e tests using [Protractor](http://www.protractortest.org)\nnpm run lint                  | Lint code\nnpm run translations:extract  | Extract strings from code and templates to `src/app/translations/template.json`\nnpm run docs                  | Display project documentation\n\nWhen building the application, you can specify the target environment using the additional flag `--env \u003cname\u003e` (do not\nforget to prepend `--` to pass arguments to npm scripts).\n\nThe default build environment is `prod`.\n\n## Development server\n\nRun `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change\nany of the source files.\nYou should not use `ng serve` directly, as it does not use the backend proxy configuration by default.\n\n## Code scaffolding\n\nRun `npm run generate -- component \u003cname\u003e` to generate a new component. You can also use\n`npm run generate -- directive|pipe|service|class|module`.\n\nIf you have installed [angular-cli](https://github.com/angular/angular-cli) globally with `npm install -g @angular/cli`,\nyou can also use the command `ng generate` directly.\n\n## Additional tools\n\nTasks are mostly based on the `angular-cli` tool. Use `ng help` to get more help or go check out the\n[Angular-CLI README](https://github.com/angular/angular-cli).\n\n# What's in the box\n\nThe app template is based on [HTML5](http://whatwg.org/html), [TypeScript](http://www.typescriptlang.org) and\n[Sass](http://sass-lang.com). The translation files use the common [JSON](http://www.json.org) format.\n\n#### Tools\n\nDevelopment, build and quality processes are based on [angular-cli](https://github.com/angular/angular-cli) and\n[NPM scripts](https://docs.npmjs.com/misc/scripts), which includes:\n\n- Optimized build and bundling process with [Webpack](https://webpack.github.io)\n- [Development server](https://webpack.github.io/docs/webpack-dev-server.html) with backend proxy and live reload\n- Cross-browser CSS with [autoprefixer](https://github.com/postcss/autoprefixer) and\n  [browserslist](https://github.com/ai/browserslist)\n- Asset revisioning for [better cache management](https://webpack.github.io/docs/long-term-caching.html)\n- Unit tests using [Jasmine](http://jasmine.github.io) and [Karma](https://karma-runner.github.io)\n- End-to-end tests using [Protractor](https://github.com/angular/protractor)\n- Static code analysis: [TSLint](https://github.com/palantir/tslint), [Codelyzer](https://github.com/mgechev/codelyzer),\n  [Stylelint](http://stylelint.io) and [HTMLHint](http://htmlhint.com/)\n- Local knowledgebase server using [Hads](https://github.com/sinedied/hads)\n- Automatic code formatting with [Prettier](https://prettier.io)\n\n#### Libraries\n\n- [Angular](https://angular.io)\n- [Bootstrap 4](https://getbootstrap.com)\n- [Font Awesome](http://fontawesome.io)\n- [RxJS](http://reactivex.io/rxjs)\n- [ng-bootstrap](https://ng-bootstrap.github.io)\n- [ngx-translate](https://github.com/ngx-translate/core)\n- [Lodash](https://lodash.com)\n\n#### Coding guides\n\n- [Angular](docs/coding-guides/angular.md)\n- [TypeScript](docs/coding-guides/typescript.md)\n- [Sass](docs/coding-guides/sass.md)\n- [HTML](docs/coding-guides/html.md)\n- [Unit tests](docs/coding-guides/unit-tests.md)\n- [End-to-end tests](docs/coding-guides/e2e-tests.md)\n\n#### Other documentation\n\n- [I18n guide](docs/i18n.md)\n- [Working behind a corporate proxy](docs/corporate-proxy.md)\n- [Updating dependencies and tools](docs/updating.md)\n- [Using a backend proxy for development](docs/backend-proxy.md)\n- [Browser routing](docs/routing.md)\n\n# Licence\n\nThe MIT License (MIT)\n\nCopyright (c) 2016-2020 Thales Services SAS\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamprof%2Fngx-rocket-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamprof%2Fngx-rocket-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamprof%2Fngx-rocket-starter-kit/lists"}