- Go to project folder and install dependencies:
npm install
- Launch development server, and open
localhost:4200
in your browser:
npm start
www/ web app production build
dist/ mobile app production build
docs/ project docs and coding guides
e2e/ end-to-end tests
src/ project source code
platforms/ Cordova platform-specific projects
plugins/ Cordova plugins
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/ |
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.
Tasks are mostly based on the angular-cli
tool. Use ng help
to get more help or go check out the
Angular-CLI README.
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
.
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
- Automatic code formatting with Prettier