docs: update README.md with testing, typechecking, and building instructions
This commit is contained in:
38
README.md
38
README.md
@@ -23,3 +23,41 @@ docker compose up -d --build
|
|||||||
By default frontend can be accessed in [localhost:4200](http://localhost:4200)
|
By default frontend can be accessed in [localhost:4200](http://localhost:4200)
|
||||||
|
|
||||||
By default backend can be accessed in [localhost:3000/api](http://localhost:3000/api)
|
By default backend can be accessed in [localhost:3000/api](http://localhost:3000/api)
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
Run tests for a specific project:
|
||||||
|
````sh
|
||||||
|
pnpm nx run web-app:test --outputStyle=static
|
||||||
|
````
|
||||||
|
|
||||||
|
Run all tests in the workspace:
|
||||||
|
````sh
|
||||||
|
pnpm nx run-many -t test --all --outputStyle=static
|
||||||
|
````
|
||||||
|
|
||||||
|
## Typechecking
|
||||||
|
|
||||||
|
Run typecheck for all projects:
|
||||||
|
````sh
|
||||||
|
pnpm nx run-many -t typecheck --all --outputStyle=static
|
||||||
|
````
|
||||||
|
|
||||||
|
Run typecheck for a single project:
|
||||||
|
````sh
|
||||||
|
pnpm nx run web-app:typecheck --outputStyle=static
|
||||||
|
pnpm nx run api:typecheck --outputStyle=static
|
||||||
|
````
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Build a specific application:
|
||||||
|
````sh
|
||||||
|
pnpm nx run web-app:build --outputStyle=static
|
||||||
|
pnpm nx run api:build --outputStyle=static
|
||||||
|
````
|
||||||
|
|
||||||
|
Build all projects that define a build target:
|
||||||
|
````sh
|
||||||
|
pnpm nx run-many -t build --all --outputStyle=static
|
||||||
|
````
|
||||||
|
|||||||
Reference in New Issue
Block a user