Basecoat Angular developer readme

Basecoat-Angular is an Angular library intended to be consumed by an Angular application. This repo contains just the Angular project and not an Angular workspace.

The goals of Basecoat-Angular are:

1. Encompass the functionality of Basecoat in Angular without jQuery
2. Provide higher-order generic components for convenient drop-in use

Prerequisits

The current version is optimized for Angular 7.2.0, but should work with Angular v8 and v9.

See package.json for the specific dependencies of Basecoat-Angular which need to be installed in the parent application.

This repo is to be cloned into yourAngularApp/projects/{basecoat-angular} in your parent app (next to your app project).

See the USP repo for an example of how to configure your parent app's angular.json, tsconfig, package.json and other specifics.

It is recommended to use the same linters and lint rules in your parent app as in the Basecoat-Angular project.

Coding standards

See https://confluence.nttltd.global.ntt/pages/viewpage.action?pageId=136154448 for info about best practices and standards.

Branching strategy

master is the main stable branch being used by Manage Centre (USP repo).

develop is the main stable branch being used by SSS (micro-app-starter repo).

develop pulls from master and should try to remain up to date with master.

Depending on which project you're working in you might branch off master or develop with the usual branch naming conventions (eg feature/JIRA-123).

Linting and testing

Because this repo isn't an Angular workspace linting and testing has to be done by a host app. It is designed to pass linting and testing in the USP repo.

From the USP/ directory you can lint and test this repo by running the following: npm run lint (lint all projects) npm run test-basecoat-angular (test basecoat-angular)

Repo inter-dependencies

There have been discussions about improving the structure of the "poly-repo" but no decisions made yet. This README just describes the current state of things.