Skip to content

Commit 0141b79

Browse files
committed
docs: simplify and refocus project instructions
Replaced extensive Nx workspace setup details with concise library-specific build and local development instructions. This refactoring aims to clarify usage steps and prioritize project relevance.
1 parent 1e029ef commit 0141b79

File tree

1 file changed

+16
-95
lines changed

1 file changed

+16
-95
lines changed

README.md

Lines changed: 16 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,22 @@
1-
# NxAngularMf
1+
# @klerick/nx-angular-mf
22

3-
<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
3+
- [Readme about lib](./libs/nx-angular-mf/README.md)
44

5-
✨ Your new, shiny [Nx workspace](https://nx.dev) is ready ✨.
65

7-
[Learn more about this workspace setup and its capabilities](https://nx.dev/getting-started/tutorials/angular-monorepo-tutorial?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
6+
## Local Development
87

9-
## Run tasks
108

11-
To run the dev server for your app, use:
9+
You can test directly the libraries by using the playground application:
1210

13-
```sh
14-
npx nx serve host-application
15-
```
16-
17-
To create a production bundle:
18-
19-
```sh
20-
npx nx build host-application
21-
```
22-
23-
To see all available targets to run for a project, run:
24-
25-
```sh
26-
npx nx show project host-application
27-
```
28-
29-
These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files.
30-
31-
[More about running tasks in the docs &raquo;](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
32-
33-
## Add new projects
34-
35-
While you could add new projects to your workspace manually, you might want to leverage [Nx plugins](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) and their [code generation](https://nx.dev/features/generate-code?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) feature.
36-
37-
Use the plugin's generator to create new projects.
38-
39-
To generate a new application, use:
40-
41-
```sh
42-
npx nx g @nx/angular:app demo
43-
```
44-
45-
To generate a new library, use:
46-
47-
```sh
48-
npx nx g @nx/angular:lib mylib
49-
```
50-
51-
You 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](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) to browse plugins and generators in your IDE.
52-
53-
[Learn more about Nx plugins &raquo;](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | [Browse the plugin registry &raquo;](https://nx.dev/plugin-registry?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
54-
55-
## Set up CI!
56-
57-
### Step 1
58-
59-
To connect to Nx Cloud, run the following command:
60-
61-
```sh
62-
npx nx connect
63-
```
64-
65-
Connecting to Nx Cloud ensures a [fast and scalable CI](https://nx.dev/ci/intro/why-nx-cloud?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) pipeline. It includes features such as:
66-
67-
- [Remote caching](https://nx.dev/ci/features/remote-cache?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
68-
- [Task distribution across multiple machines](https://nx.dev/ci/features/distribute-task-execution?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
69-
- [Automated e2e test splitting](https://nx.dev/ci/features/split-e2e-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
70-
- [Task flakiness detection and rerunning](https://nx.dev/ci/features/flaky-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
71-
72-
### Step 2
73-
74-
Use the following command to configure a CI workflow for your workspace:
75-
76-
```sh
77-
npx nx g ci-workflow
78-
```
79-
80-
[Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
81-
82-
## Install Nx Console
83-
84-
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.
85-
86-
[Install Nx Console &raquo;](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
87-
88-
## Useful links
89-
90-
Learn more:
91-
92-
- [Learn more about this workspace setup](https://nx.dev/getting-started/tutorials/angular-monorepo-tutorial?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects)
93-
- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
94-
- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
95-
- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
96-
97-
And join the Nx community:
98-
- [Discord](https://go.nx.dev/community)
99-
- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
100-
- [Our Youtube channel](https://www.youtube.com/@nxdevtools)
101-
- [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
11+
1. Build builder:
12+
```shell
13+
nx build nx-angular-mf
14+
```
15+
2. Start the `first remote` application:
16+
```shell
17+
npx nx run mf1-application:serve
18+
```
19+
3. Start the `remote` application:
20+
```shell
21+
npx nx run host-application:serve
22+
```

0 commit comments

Comments
 (0)