Skip to content

Latest commit

 

History

History
286 lines (197 loc) · 7.29 KB

README.md

File metadata and controls

286 lines (197 loc) · 7.29 KB
Raw

bcgov/nrts-prc-admin

Administrative front-end for the ACRFD (formerly: PRC) application.

  • Admin - front-end for admin users.
  • Public - front-end for public users.
  • Api - back-end that serves both admin and public requests.

Prerequisites

Technology Version Website Description
node 10.x.x https://nodejs.org/en/ JavaScript Runtime
npm 6.x.x https://www.npmjs.com/ Node Package Manager
ng 6.x.x https://cli.angular.io/ Angular CLI
yarn latest https://yarnpkg.com/en/ Package Manager (more efficient than npm)

Note: This app also requires bcgov/nrts-prc-api to handle its requests and authentication.

Install Node + NPM

Note: Windows users can use NVM Windows to install and manage multiple versions of Node+Npm.

Install Angular CLI

Note: Use @angular/cli. Do not use @angular/angular-cli.

npm install -g @angular/cli

Install Yarn

npm install -g yarn

Build and Run

Dev

  1. Download dependencies
yarn install
  1. Run the app
npm start

  1. Go to http://localhost:4200 to verify that the application is running.

    Note: To change the default port edit angular.json.

Prod

  1. Download dependencies
yarn install

  1. Run the build

    The build artifacts will be stored in the ./dist/ directory.

npm run build
  1. (Optional) Use the --prod flag to run the app in prod mode
ng serve --prod

Linting and Formatting

Info

Linting and formatting is handled by a combiation of TSlint and Prettier. The reason for this, is that you get the best of both worlds: TSlint's larger selection of linting rules with Prettier's robust formatting rules.

These 2 linters (tslint, Prettier) do have overlapping rules. To avoid weird rule interactions, TSlint has been configured to defer any overlapping rules to Prettier, via the use of tslint-config-prettier in tslint.json.

Recommend installing the VSCode Prettier extension, so Prettier's formatting can be applied on-the-fly.

Technolgies used

TSLint, Prettier, Stylelint, husky, lint-staged

Configuration files

  • TSlint: tslint.json
  • Prettier: .prettierrc .prettierignore
  • Stylelint: .styleintrc
  • Husky: .huskyrc
  • lint-staged: .lintstagedrc

Pre-Commit Hooks

Package.json has been configured to use husky with lint-staged to run the lint-fix (linting + formatting) commands, against the files staged to be committed, whenever you perform a commit. This ensures that all committed code has been linted and formatted correctly.

If the linters or formatters find issues that cannot be automatically fixed, it will throw an error and provide output as to what is wrong. Fix the issues and commit again.

Run Linters

  • Lint the *.ts files using TSLint.
npm run lint:ts
  • Lint the *.scss files using Stylelint.
npm run lint:scss
  • Run all linters in series
npm run lint

Run Linters + Formatters

Note: In the worst case scenario, where linting/formatting has been neglected, then these lint-fix commands have the potential to create hundreds or thousands of file changes. In this case, it is recommended to only run these commands as part of a separate commit.

Note: Not all linting/formatting errors can be automatically fixed, and will require human intervention.

  • Lint and fix the *.ts files using TSLint + Prettier.
npm run lint-fix:ts
  • Lint and fix the *.scss files using Stylelint.
npm run lint-fix:scss
  • Run all linters and fix all problems, in series
npm run lint-fix

Testing

Info

Technolgies used

Jasmine, Karma, Protractor

Important Note

When viewing test output in the browser, via localhost:9876, Firefox produces somewhat cryptic error output. Chrome doesn't have this issue.

Run Tests

  • Run the unit tests with watch=true
npm run tests

  • Run the unit tests with watch=false and run the coverage report

    View the coverage report at ./coverage/index.html

npm run tests-ci

  • Run the end-to-end tests

    Before running the tests make sure you are serving the app via ng serve

npm run e2e

Code Scaffolding Using Angular CLI

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|module.

Example: Generate a customer component

ng g c customer

Example: Generate a directive: search-box

ng g d search-box

Example: Generate a service: general-data

ng g s general-data

Angular will give out a warning line after this command:

WARNING Service is generated but not provided, it must be provided to be used

After generating a service, we must go to its owning module and add the service to the providers array.

Example: Generate a service and include it in a module automatically

ng g s general-data2 -m app.module

Example: Generate a class, an interface and enum

# class
ng g cl models/customer

# interface
ng g i models/person

# enum
ng g enum models/gender

Example: Generate a pipe

ng g pipe shared/init-caps

Generate a module

Create a login directory and generate a login module in that directory.

ng g module login/login.module

Add/Generate Routing Features

Generate a module called admin and add routing feature to it.

ng g module admin --routing

Change aspects of the application

Change style dialect

ng set default.styleExt css

Regenerate a brand new project with routing and scss options

ng new my-app --routing --style scss

OpenShift Build and Deployment

For dev, test, and prod builds on OpenShift/Jenkins see openshift/README.md for detailed instructions on how to setup in an OpenShift environment using nginx.

How to Contribute

Create pull requests against the master branch.

VSCode Extensions

A list of recommended/helpful VS Code extensions.

Linting/Formatting

  • TSLint
  • ESLint
  • Prettier - Code formatter
  • stylelint
  • EditorConfig for VS Code

Languages

  • npm
  • Angular Extension pack
    • This may include 'Beautify' which should be disabled as we are using Prettier.
  • JavaScript (ES6) code snippets

General

  • Auto Comment Blocks
  • Auto-Open Markdown Preview
  • autoDocstring
  • Document This
  • Better Comments
  • Bracket Pair Colorizer
  • Code Spell Checker
  • Declarative Jenkinsfile Support
  • Path intellisense
  • SCSS intellisense
  • Shell launcher