arbetsformedlingen/mina-sidor-fa-web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added start of the documentation

Browse Source
This commit is contained in:
Erik Tiekstra
2021-04-06 07:34:04 +02:00
committed by Erik Tiekstra
parent cb5cb8b486
commit 5448643d8e
4 changed files with 1011 additions and 379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
README.md
View File

@@ -1,105 +1,57 @@
# DAFA-web
# AppsJsMonorepoVision
This project was generated using [Nx](https://nx.dev).
<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p>
🔎 **Nx is a set of Extensible Dev Tools for Monorepos.**
The project was generated using [Nx](https://nx.dev).
## Quick Start & Documentation
For all commands we will refer to the `npm scripts` located inside [package.json](./package.json). When using these commands, you do not need to have `@angular/cli` installed globally on your computer.
To get started, clone the repository and run `npm install` in the root of the project, this will install all dependencies.
### Development server DAFA-web
Run `npm run start:dafa` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
### Generate an application
Run `npm run new-app my-app` to generate an application. When using Nx, you can create multiple applications and libraries in the same workspace.
### Generate a library
Run `npm run new-lib my-lib` to generate a library. Libraries are shareable across libraries and applications. They can be imported from `@dafa-web-monorepo/mylib`.
### Code scaffolding
Run `npm run new-component my-component --project=my-app` to generate a new component.
### Build DAFA-web
Run `npm run build:dafa` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
### Running unit tests on DAFA-web
Run `npm run test:dafa` to execute the unit tests via [Jest](https://jestjs.io).
Run `npm run nx affected:test` to execute the unit tests affected by a change.
### Running end-to-end tests on DAFA-web
Run `npm run e2e:dafa` to execute the end-to-end tests via [Cypress](https://www.cypress.io).
Run `npm run nx affected:e2e` to execute the end-to-end tests affected by a change.
### Understand your workspace
Run `npm run nx dep-graph` to see a diagram of the dependencies of your projects.
##
Using the mock-api
## General Nx documentation
[Nx Documentation](https://nx.dev/angular)
[10-minute video showing all Nx features](https://nx.dev/angular/getting-started/what-is-nx)
[Interactive Tutorial](https://nx.dev/angular/tutorial/01-create-application)
## Adding capabilities to your workspace
Nx supports many plugins which add capabilities for developing different types of applications and different tools.
These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.
Below are our core plugins:
- [Angular](https://angular.io)
- `ng add @nrwl/angular`
- [React](https://reactjs.org)
- `ng add @nrwl/react`
- Web (no framework frontends)
- `ng add @nrwl/web`
- [Nest](https://nestjs.com)
- `ng add @nrwl/nest`
- [Express](https://expressjs.com)
- `ng add @nrwl/express`
- [Node](https://nodejs.org)
- `ng add @nrwl/node`
There are also many [community plugins](https://nx.dev/nx-community) you could add.
## Generate an application
Run `ng g @nrwl/angular:app my-app` to generate an application.
> You can use any of the plugins above to generate applications as well.
When using Nx, you can create multiple applications and libraries in the same workspace.
## Generate a library
Run `ng g @nrwl/angular:lib my-lib` to generate a library.
> You can also use any of the plugins above to generate libraries as well.
Libraries are shareable across libraries and applications. They can be imported from `@dafa-web-monorepo/mylib`.
## Development server
Run `ng serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
## Code scaffolding
Run `ng g component my-component --project=my-app` to generate a new component.
## Build
Run `ng build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
## Running unit tests
Run `ng test my-app` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx affected:test` to execute the unit tests affected by a change.
## Running end-to-end tests
Run `ng e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io).
Run `nx affected:e2e` to execute the end-to-end tests affected by a change.
## Understand your workspace
Run `nx dep-graph` to see a diagram of the dependencies of your projects.
## Further help
Visit the [Nx Documentation](https://nx.dev/angular) to learn more.
## ☁ Nx Cloud
### Computation Memoization in the Cloud
<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-cloud-card.png"></p>
Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.
Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.
Visit [Nx Cloud](https://nx.app/) to learn more.