Added start of the documentation
This commit is contained in:
Erik Tiekstra
committed by
Erik Tiekstra
Erik Tiekstra
parent
cb5cb8b486
commit
5448643d8e
144
README.md
144
README.md
@@ -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.
|
||||
|
||||
22
nx.json
22
nx.json
@@ -1,34 +1,22 @@
|
||||
{
|
||||
"implicitDependencies": {
|
||||
"angular.json": "*",
|
||||
"package.json": {
|
||||
"dependencies": "*",
|
||||
"devDependencies": "*"
|
||||
},
|
||||
"package.json": { "dependencies": "*", "devDependencies": "*" },
|
||||
"tsconfig.base.json": "*",
|
||||
"tslint.json": "*",
|
||||
".eslintrc.json": "*",
|
||||
"nx.json": "*"
|
||||
},
|
||||
"affected": {
|
||||
"defaultBase": "master"
|
||||
},
|
||||
"affected": { "defaultBase": "master" },
|
||||
"npmScope": "dafa-web-monorepo",
|
||||
"tasksRunnerOptions": {
|
||||
"default": {
|
||||
"runner": "@nrwl/workspace/tasks-runners/default",
|
||||
"options": {
|
||||
"cacheableOperations": ["build", "lint", "test", "e2e"]
|
||||
}
|
||||
"options": { "cacheableOperations": ["build", "lint", "test", "e2e"] }
|
||||
}
|
||||
},
|
||||
"projects": {
|
||||
"dafa-web": {
|
||||
"tags": []
|
||||
},
|
||||
"dafa-web-e2e": {
|
||||
"tags": [],
|
||||
"implicitDependencies": ["dafa-web"]
|
||||
}
|
||||
"dafa-web": { "tags": [] },
|
||||
"dafa-web-e2e": { "tags": [], "implicitDependencies": ["dafa-web"] }
|
||||
}
|
||||
}
|
||||
|
||||
1216
package-lock.json
generated
1216
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -11,8 +11,11 @@
|
||||
"postinstall": "node ./decorate-angular-cli.js && ngcc --properties es2015 browser module main",
|
||||
"nx": "nx",
|
||||
"start": "ng serve",
|
||||
"start:dafa": "ng serve dafa-web",
|
||||
"build": "ng build",
|
||||
"build:dafa": "ng build dafa-web",
|
||||
"test": "ng test",
|
||||
"test:dafa": "ng test dafa-web",
|
||||
"lint": "nx workspace-lint && ng lint",
|
||||
"e2e": "ng e2e",
|
||||
"affected:apps": "nx affected:apps",
|
||||
@@ -29,7 +32,10 @@
|
||||
"update": "nx migrate latest",
|
||||
"workspace-generator": "nx workspace-generator",
|
||||
"dep-graph": "nx dep-graph",
|
||||
"help": "nx help"
|
||||
"help": "nx help",
|
||||
"new-app": "nx g @nrwl/angular:app",
|
||||
"new-lib": "nx g @nrwl/angular:lib",
|
||||
"new-component": "nx g c"
|
||||
},
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
|
||||
Reference in New Issue
Block a user