uiux Material
Projects ( Libraries )
This project was generated with Angular CLI version 6.0.1. This tool should be utilized as much as possible to generate new code, lint, test. Using the Angular CLI ensures Google support and standards for project architecture, lint, and testing, and provides the best structure for successful platform upgrades.
The current projects in this repo include:
- @uiux/cdk
- @uiux/material
- uiux Documentation Site
Getting Started
Node 8.10.0 is required. Recomment using Node Version Manager to quickly change node among different development environments.
-
Run
nvm use
to use the version of node required for this repo. You may have to install the correct version of node ( See Node Version Manager docs ). -
Install development tools globally
npm install -g @angular/cli yarn @uiux/cli
-
Clone this repo.
-
Run
yarn install
.
Workflows
See the differne workflows to understand how to add code in each proejct.
Adding a library
See ./src/assets/guides/ANGULAR_LIBRARY.md
Semver
Use yarn commands to increments the version of project. This will update package.json
files in the CDK, Material, Icons, Docs App, and assets folder.
The package.json
at the root of this repo contains the version which incrementing semver is based.
If the root package.json
version is 6.2.3:
yarn run bump --ver=8.0.1
updates version to 8.0.1
yarn bump.major
updates version to 7.0.0
yarn bump.minor
updates version to 6.3.0
yarn bump.patch
updates version to 6.2.4
Bumping alpha, beta, and rc only appends or increments the current version with something like -rc.1
, -alpha.1
, or -beta.1
. If you want to increment the major, minor, or patch versions as well, run those commands first.
yarn bump.alpha
updates version to 6.2.3-alpha.1
yarn bump.beta
updates version to 6.2.3-beta.1
yarn bump.rc
updates version to 6.2.3-rc.1
Releasing Projects
I have tried to automate this process with a script, but my two-factor authentication token for GitHub is not recognized when running npm publish
inside of a script. Any help is appreciated.
-
Bump semver.
-
Build projects by runing
yarn build.projects
. -
In the
dist/
path, cd into each project's directory containing it'spackage.json
file, and runnpm publish
. Do not do this for the Icon's directory.cd ./dist/@uiux/cdk npm publish cd ./dist/@uiux/material npm publish cd ./projects/uiux/icons npm publish
-
CD into
projects/uiux/icons
directory, and runnpm publish
.
Code scaffolding
Run ng generate component component-name
to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module
.
Further help
To get more help on the Angular CLI use ng help
or go check out the Angular CLI README.