Skip to content

Commit a9a93c6

Browse files
authored
Update README.md (#3)
1 parent 24338b6 commit a9a93c6

File tree

1 file changed

+7
-19
lines changed

1 file changed

+7
-19
lines changed

README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,25 @@
1-
2-
31
# NX NestJS React starter
42

3+
Bootstrapped, ready-for-production (Mono-)Repository for TypeScript environments using NestJS + React.
54
This project was generated using [Nx](https://nx.dev).
65

7-
<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p>
8-
96
🔎 **Smart, Extensible Build Framework**
107

118
## Project setup / initialization
12-
This project setup was created by executing folling steps
13-
14-
1) install nx globally `npm i nx`
15-
2) initialize new nx workspace with default react-app
16-
`npx create-nx-workspace@latest nx-nestjs-react-starter`
17-
3) use package manager of choice to install dependency for NestJS
18-
`yarn add -D @nrwl/nest`
19-
`npm install -D @nrwl/nest`
209

21-
4) add a new nestjs app to the workspace
22-
`npx nx g @nrwl/nest:app api --frontendProject=client`
10+
This project setup was created by executing folling steps
2311

24-
5) add a shared library
25-
`nx g @nrwl/node:library mylib`
12+
- install nx globally `npm i nx`
13+
- install dependencies `npm install` or `npm i`
2614

15+
### adjust package.json
2716

28-
### adjust package.json
2917
support linting and testing for all applications at once
3018
`"test": "npx nx run-many --all --target=test --parallel"`
3119
`"lint": "nx workspace-lint && npx nx run-many --all --target=lint --parallel"`
3220

3321
add separate run & build scripts for backend and frontend
34-
`"start:client": "nx run client:serve"`
22+
`"start:client": "nx run client:serve"`
3523
`"start:api": "nx run api:serve"`
3624

3725
## Adding capabilities to your workspace
@@ -68,7 +56,7 @@ Libraries are shareable across libraries and applications. They can be imported
6856

6957
## Development server
7058

71-
Run `nx serve client` for a frontend dev server. Navigate to http://localhost:4200/.
59+
Run `nx serve client` for a frontend dev server. Navigate to http://localhost:4200/.
7260
Run `nx serve api` for a backend dev server. Navigate to http://localhost:3333/api.
7361
The app will automatically reload if you change any of the source files.
7462

0 commit comments

Comments
 (0)