Skip to content

Commit 60a6088

Browse files
committed
docs: update README with setup instructions and add new commands for generating and removing projects
1 parent 850af33 commit 60a6088

File tree

2 files changed

+23
-15
lines changed

2 files changed

+23
-15
lines changed

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,23 @@
11
# SquareMe
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>
4-
5-
✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨.
6-
7-
[Learn more about this workspace setup and its capabilities](https://nx.dev/nx-api/nest?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!
8-
9-
## Finish your CI setup
10-
11-
[Click here to finish setting up your workspace!](https://cloud.nx.app/connect/zB2fTfzvKU)
3+
## Setup
124

5+
1. Install `nodejs "^20.0.0"`
6+
2. Install `pnpm`
7+
3. Install `Docker` and `docker-compose`
138

149
## Run tasks
1510

16-
To run the dev server for your app, use:
11+
To run the dev server for all the microservice:
1712

1813
```sh
19-
npx nx serve auth
14+
pnpm dev
2015
```
2116

22-
To create a production bundle:
17+
To create a production bundle for all the microservice:
2318

2419
```sh
25-
npx nx build auth
20+
pnpm build
2621
```
2722

2823
To see all available targets to run for a project, run:
@@ -53,11 +48,22 @@ To generate a new library, use:
5348
npx nx g @nx/node:lib mylib
5449
```
5550

51+
To generate a new library nestjs controller schematic in apps use:
52+
53+
```sh
54+
npx nx g @nx/nest:<schematic> [apps | libs]/<appName>/src/app/<app-module-folder>/<schematic-name>
55+
```
56+
57+
To remove app or lib from workspace use:
58+
59+
```sh
60+
npx nx generate @nx/workspace:remove --projectName=<app-or-lib-name>
61+
```
62+
5663
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.
5764

5865
[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)
5966

60-
6167
[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)
6268

6369
## Install Nx Console
@@ -70,12 +76,13 @@ Nx Console is an editor extension that enriches your developer experience. It le
7076

7177
Learn more:
7278

73-
- [Learn more about this workspace setup](https://nx.dev/nx-api/nest?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects)
79+
- [Learn more about this workspace setup](https://nx.dev/nx-api/nest?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
7480
- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
7581
- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
7682
- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
7783

7884
And join the Nx community:
85+
7986
- [Discord](https://go.nx.dev/community)
8087
- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
8188
- [Our Youtube channel](https://www.youtube.com/@nxdevtools)

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"scripts": {
66
"prepare": "husky",
77
"dev": "nx run-many -t serve -p auth transaction wallet integration notification",
8+
"build": "nx run-many -t build -p auth transaction wallet integration notification",
89
"migration:run": "nx run-many -t migration:run -p auth transaction wallet",
910
"upgrade:nestjs": "npx npm-check-updates -u -f \"/nestjs*/\" ",
1011
"typeorm": "typeorm-ts-node-commonjs",

0 commit comments

Comments
 (0)