Ng(Nx) Libraries

This project was generated using Nx - Angular 14.0.2

Libraries in this repo

Code for the libraries of @ng-ar/fa-input, @ng-ar/prime-input, @ng-ar/tab, @ng-ar/modal and @ng-ar/mask are included in this repo.

How I created this repo

installing NX globally

npm install -g nx

creating nx workspace with angular

npx create-nx-workspace --preset=angular

running angular app in development

nx serve app-name

to see the files to be changed or created while creating component, use the flag --dry-run

nx g c home-page --project=project-name --dry-run

• Getting started with NX and Angular

Quick Start & Documentation

Nx Documentation

10-minute video showing all Nx features

Interactive Tutorial

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

• Angular
  • ng add @nrwl/angular
• React
  • ng add @nrwl/react
• Web (no framework frontends)
  • ng add @nrwl/web
• Nest
  • ng add @nrwl/nest
• Express
  • ng add @nrwl/express
• Node
  • ng add @nrwl/node

There are also many community plugins you could add.

Generate an application

Run ng g @nrwl/angular:app my-app to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run ng g @nrwl/angular:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are shareable across libraries and applications. They can be imported from @nx-monorepo-practice/mylib.

Generating publishable library in nx and publishing

ng g @nrwl/angular:lib lib1 --publishable --importPath="@<organization_name>/lib1"

ng g @nrwl/angular:lib lib1 --publishable --importPath="@<organization_name>/lib1" --tags="scope:public,type:util,target:all"

ng g @nrwl/angular:lib lib2 --publishable --importPath="lib2"

• Building

  $ nx build lib1
  $ nx build lib2

• You will find built and ready to publish versions in dist/libs/lib1 and dist/libs/lib2. Now we ready to publish it to npm. You need to go to dist directory of your project

  cd /dist/libs/lib1

• Publishing

  npm publish --access public

Development server

Run ng serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng g component my-component --project=my-app to generate a new component.

Build

Run ng build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test my-app to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx graph to see a diagram of the dependencies of your projects.

Deploy to GitHub Pages

1. To begin, add the angular-cli-ghpages builder.

ng add angular-cli-ghpages

2. If you’re deploying the project to a Github project page you’ll need to set the baseHref property as the repository name. The baseHref will be used for all relative URLs on your site. You could specify the baseHref as part of the project architect deploy options in the angular.json file. Or just pass it as the --base-href flag to the ng deploy command. If you’re deploying the project to a Github user page, you do not need to set this option.

ng deploy --base-href=/<repository-name>/

GitHub will automatically enable Pages when you push a gh-pages branch. There is no need to enable Pages from the repository settings.

ng deploy --base-href=/ng-my-libraries/

3. Remove angular-cli-ghpages after deployemnt as it's not supporting angular 14.

git stash -u && git stash drop

Resources

• What’s New in Angular 14?
• Publishable libraries with Nx Monorepo - part 1
• HOW TO DEPLOY NPM MODULES IN AN NX MONOREPO AND GITHUB ACTIONS?
• How To Use Font Awesome icons in Angular Applications
• TypeScript: Any | Unknown | Never
• When to use never and unknown in TypeScript
• Get an Enum Key by Value in TypeScript
• Display IE ::ms-clear pseudo element in small input elements?
• Creating libraries - Official
• The Angular Library Series - Creating a Library with Angular CLI
• Create your Angular Library and linking
• Define a Type for Object with Dynamic keys in TypeScript

Further help

Visit the Nx Documentation to learn more.

☁ Nx Cloud

Distributed Computation Caching & Distributed Task Execution

Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.

Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.

Visit Nx Cloud to learn more.