kastenmike / czechsalary

CzechSalary

Calculation of net wages for employees in Czech Republic - 2022.

Getting started

1. Go to project folder and install dependencies:

npm install

2. Launch development server, and open localhost:4200 in your browser:

npm start

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 prettier	Automatically format all .ts, .js & .scss files

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.

Tools

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

Libraries

• Angular
• Angular Material
• Angular Flex Layout
• Material Icons
• RxJS
• ngx-translate
• Lodash

Coding guides

• Angular
• TypeScript
• Sass
• HTML
• Unit tests
• End-to-end tests

Other documentation

• I18n guide
• Working behind a corporate proxy
• Updating dependencies and tools
• Using a backend proxy for development
• Browser routing