You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Konstantinos Kamaropoulos e30571af21 feat: setup ngx-rocket boilerplate code 5 years ago
docs feat: setup ngx-rocket boilerplate code 5 years ago
e2e feat: setup ngx-rocket boilerplate code 5 years ago
src feat: setup ngx-rocket boilerplate code 5 years ago
.editorconfig feat: setup ngx-rocket boilerplate code 5 years ago
.gitignore feat: setup ngx-rocket boilerplate code 5 years ago
.htmlhintrc feat: setup ngx-rocket boilerplate code 5 years ago
.stylelintrc feat: setup ngx-rocket boilerplate code 5 years ago
.yo-rc.json feat: setup ngx-rocket boilerplate code 5 years ago
README.md feat: setup ngx-rocket boilerplate code 5 years ago
angular.json feat: setup ngx-rocket boilerplate code 5 years ago
karma.conf.js feat: setup ngx-rocket boilerplate code 5 years ago
ngsw-config.json feat: setup ngx-rocket boilerplate code 5 years ago
package-lock.json feat: setup ngx-rocket boilerplate code 5 years ago
package.json feat: setup ngx-rocket boilerplate code 5 years ago
proxy.conf.js feat: setup ngx-rocket boilerplate code 5 years ago
tsconfig.app.json feat: setup ngx-rocket boilerplate code 5 years ago
tsconfig.json feat: setup ngx-rocket boilerplate code 5 years ago
tsconfig.spec.json feat: setup ngx-rocket boilerplate code 5 years ago
tslint.json feat: setup ngx-rocket boilerplate code 5 years ago

README.md

Aiolos

This project was generated with ngX-Rocket version 7.1.0

Getting started

  1. Go to project folder and install dependencies:
npm install
  1. Launch development server, and open localhost:4200 in your browser:
npm start

Project structure

dist/                        web 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

Main tasks

Task automation is based on NPM scripts.

Task Description
npm start Run development server on http://localhost:4200/
npm run serve:sw Run test server on http://localhost:4200/ with service worker enabled
npm run build [-- --configuration=production] Lint code and build web app for production (with AOT) 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 and coding guides
npm run prettier Automatically format all .ts, .js & .scss files

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

The default build configuration 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 <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.

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.

Code formatting

All .ts, .js & .scss files in this project are formatted automatically using Prettier, and enforced via the test:ci script.

A pre-commit git hook has been configured on this project to automatically format staged files, using (pretty-quick)[https://github.com/azz/pretty-quick], so you don't have to care for it.

You can also force code formatting by running the command npm run prettier.

What's in the box

The app template is based on HTML5, TypeScript and Sass. The translation files use the common JSON format.

Tools

Development, build and quality processes are based on angular-cli and NPM scripts, which includes:

Libraries

Coding guides

Other documentation