PhenomDisplay

This is the Phenom Display component's Nx monorepo.

The following apps, services and libs are part of it:

Apps and services: (found under apps/*)

• article-generation-service - nest.js
• article-metadata-service - nest.js
• dcms - Strapi, Headless Node.js CMS
• search-service - nest.js
• website 3.0 front-end application - next.js

*Obs: You may look for the individual README files that can be found inside each of the apps, for more information.

Libs (found under libs/*):

• phenom-website-design-system - ant design, storybook

Development server

Run nx 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.

Build

Run nx 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 nx 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.

Publishing phenom-website-design-system UI library

In order to be able to publish a new version for phenom-website-design-system, you must first own a NPM account that has rights to publish on packages owned by Hindawi Organization. You may ask internally for someone to provide you the necessary access rights.

If you already own an account that has publish rights, you may run npm login and provide all the prompted details in order for the package manager to gain access on your local machine to the global npm registry.

After that, follow these steps:

1. navigate to libs\phenom-website-design-system and make sure the package.json located within the folder has the property "version" updated with the new SEMVER value you want to publish; you may achieve that either by changing it manually or by using npm version
2. go back to the root folder of the monorepo and run npm run deploy-lib - this command includes all the necessary steps to be done before the actual publish ( you can check "deploy-lib" inside "scripts" in root's package.json )

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:

• React
  • npm install --save-dev @nrwl/react
• Web (no framework frontends)
  • npm install --save-dev @nrwl/web
• Angular
  • npm install --save-dev @nrwl/angular
• Nest
  • npm install --save-dev @nrwl/nest
• Express
  • npm install --save-dev @nrwl/express
• Node
  • npm install --save-dev @nrwl/node

There are also many community plugins you could add.

Generate an application

Run nx g @nrwl/react: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 nx g @nrwl/react: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 @phenom-display/mylib.

Code scaffolding

Run nx g @nrwl/react:component my-component --project=my-app to generate a new component.

Understand your workspace

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

Further help

Visit the Nx Documentation to learn more.