✨ Your new, shiny Nx workspace is almost ready ✨.
Learn more about this workspace setup and its capabilities or run npx nx graph to visually explore what was created. Now, let's get you up to speed!
Services may use different names for domains than the canonical name. The catalog application captures and displays these service-specific aliases to help understand how different systems refer to the same data concepts.
Example:
- Domain: Commercial Items (canonical name)
- JPharm: Refers to it as "References"
- Other Services: Use the standard name "Commercial Items"
Where aliases appear:
- Domain List: Shows a count of service-specific names and displays them as tags
- Service View: Displays domains with their aliases in the format "Domain Name (known as: Alias)"
- Data Flow Diagram: Annotates service nodes with aliases below the service name
Data Model:
Aliases are defined in the data flow JSON files (src/assets/*-data-flow.json) by adding an optional aliases array to service nodes:
{
"id": "JPharm",
"modifies": false,
"aliases": ["References"]
}Note: Only add the aliases field when a service uses a different name than the canonical domain name. Omit it when the service uses the standard name to avoid redundancy.
Click here to finish setting up your workspace!
To run the dev server for your app, use:
npx nx serve catalogTo create a production bundle:
npx nx build catalogTo see all available targets to run for a project, run:
npx nx show project catalogThese targets are either inferred automatically or defined in the project.json or package.json files.
More about running tasks in the docs »
While you could add new projects to your workspace manually, you might want to leverage Nx plugins and their code generation feature.
Use the plugin's generator to create new projects.
To generate a new application, use:
npx nx g @nx/angular:app demoTo generate a new library, use:
npx nx g @nx/angular:lib mylibYou can use npx nx list to get a list of installed plugins. Then, run npx nx list <plugin-name> to learn about more specific capabilities of a particular plugin. Alternatively, install Nx Console to browse plugins and generators in your IDE.
Learn more about Nx plugins » | Browse the plugin registry »
Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
Learn more:
- Learn more about this workspace setup
- Learn about Nx on CI
- Releasing Packages with Nx release
- What are Nx plugins?
And join the Nx community: