Skip to content

Commit

Permalink
docs(md): update getting-started
Browse files Browse the repository at this point in the history
  • Loading branch information
ng-nest-moon committed Nov 30, 2024
1 parent 5e5c487 commit b2cfec5
Show file tree
Hide file tree
Showing 52 changed files with 541 additions and 861 deletions.
2 changes: 1 addition & 1 deletion docs/course/rbac/1-introduction/readme.en_US.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ After completing all the steps in this tutorial, the final application will look

## Current environment

angular ^18.0.0 | nestjs ^7.0.0
angular ^19.0.0 | nestjs ^7.0.0

Refer to the following address for environment installation:<a href="https://angular.cn/guide/setup-local" target="_blank">Angular</a> | <a href="https://docs.nestjs.com/" target="_blank">Nestjs</a>

Expand Down
2 changes: 1 addition & 1 deletion docs/course/rbac/1-introduction/readme.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ default: true

## 当前环境

angular ^18.0.0 | nestjs ^7.0.0
angular ^19.0.0 | nestjs ^7.0.0

环境安装参考以下地址:<a href="https://angular.cn/guide/setup-local" target="_blank">Angular</a> | <a href="https://docs.nestjs.com/" target="_blank">Nestjs</a>

Expand Down
16 changes: 10 additions & 6 deletions docs/ui/getting-started/demo/1__bash/1.bash
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
$ ng new my-app
? Would you like to add Angular routing? Yes
? Which stylesheet format would you like to use?
CSS
> SCSS [ https://sass-lang.com/documentation/syntax#scss ]
Sass [ https://sass-lang.com/documentation/syntax#the-indented-syntax ]
Less [ http://lesscss.org ]
Stylus [ http://stylus-lang.com ]
CSS [ https://developer.mozilla.org/docs/Web/CSS ]
❯ Sass (SCSS) [ https://sass-lang.com/documentation/syntax#scss ]
Sass (Indented) [ https://sass-lang.com/documentation/syntax#the-indented-syntax ]
Less [ http://lesscss.org ]

✔ Which stylesheet format would you like to use? Sass (SCSS) [
https://sass-lang.com/documentation/syntax#scss ]

✔ Do you want to enable Server-Side Rendering (SSR) and Static Site Generation
(SSG/Prerendering)? no
2 changes: 1 addition & 1 deletion docs/ui/getting-started/demo/1__bash/__1.bash.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
info: '5'
info: 4,8,11
---
17 changes: 0 additions & 17 deletions docs/ui/getting-started/demo/1__my-app/.browserslistrc

This file was deleted.

1 change: 1 addition & 0 deletions docs/ui/getting-started/demo/1__my-app/.editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ trim_trailing_whitespace = true

[*.ts]
quote_type = single
ij_typescript_use_double_quotes = false

[*.md]
max_line_length = off
Expand Down
25 changes: 11 additions & 14 deletions docs/ui/getting-started/demo/1__my-app/.gitignore
Original file line number Diff line number Diff line change
@@ -1,45 +1,42 @@
# See http://help.github.com/ignore-files/ for more about ignoring files.
# See https://docs.github.com/get-started/getting-started-with-git/ignoring-files for more about ignoring files.

# compiled output
# Compiled output
/dist
/tmp
/out-tsc
# Only exists if Bazel was run
/bazel-out

# dependencies
# Node
/node_modules

# profiling files
chrome-profiler-events*.json
npm-debug.log
yarn-error.log

# IDEs and editors
/.idea
.idea/
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
# Visual Studio Code
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
.history/*

# misc
/.sass-cache
# Miscellaneous
/.angular/cache
.sass-cache/
/connect.lock
/coverage
/libpeerconnection.log
npm-debug.log
yarn-error.log
testem.log
/typings

# System Files
# System files
.DS_Store
Thumbs.db
52 changes: 42 additions & 10 deletions docs/ui/getting-started/demo/1__my-app/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,59 @@
# my-app
# MyApp

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.0.3.
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.0.0.

## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
To start a local development server, run:

```bash
ng serve
```

Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:

```bash
ng generate component component-name
```

For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:

```bash
ng generate --help
```

## Build
## Building

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
To build the project run:

```bash
ng build
```

This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.

## Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:

```bash
ng test
```

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
For end-to-end (e2e) testing, run:

```bash
ng e2e
```

Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.

## Further help
## Additional Resources

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
61 changes: 26 additions & 35 deletions docs/ui/getting-started/demo/1__my-app/angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,28 @@
"schematics": {
"@schematics/angular:component": {
"style": "scss"
},
"@schematics/angular:application": {
"strict": true
}
},
"root": "",
"sourceRoot": "src",
"prefix": "app",
"architect": {
"build": {
"builder": "@angular-devkit/build-angular:browser",
"builder": "@angular-devkit/build-angular:application",
"options": {
"outputPath": "dist/my-app",
"index": "src/index.html",
"main": "src/main.ts",
"polyfills": "src/polyfills.ts",
"browser": "src/main.ts",
"polyfills": [
"zone.js"
],
"tsConfig": "tsconfig.app.json",
"inlineStyleLanguage": "scss",
"assets": [
"src/favicon.ico",
"src/assets"
{
"glob": "**/*",
"input": "public"
}
],
"styles": [
"src/styles.scss"
Expand All @@ -40,30 +41,21 @@
"budgets": [
{
"type": "initial",
"maximumWarning": "500kb",
"maximumError": "1mb"
"maximumWarning": "500kB",
"maximumError": "1MB"
},
{
"type": "anyComponentStyle",
"maximumWarning": "2kb",
"maximumError": "4kb"
}
],
"fileReplacements": [
{
"replace": "src/environments/environment.ts",
"with": "src/environments/environment.prod.ts"
"maximumWarning": "4kB",
"maximumError": "8kB"
}
],
"outputHashing": "all"
},
"development": {
"buildOptimizer": false,
"optimization": false,
"vendorChunk": true,
"extractLicenses": false,
"sourceMap": true,
"namedChunks": true
"sourceMap": true
}
},
"defaultConfiguration": "production"
Expand All @@ -72,31 +64,31 @@
"builder": "@angular-devkit/build-angular:dev-server",
"configurations": {
"production": {
"browserTarget": "my-app:build:production"
"buildTarget": "my-app:build:production"
},
"development": {
"browserTarget": "my-app:build:development"
"buildTarget": "my-app:build:development"
}
},
"defaultConfiguration": "development"
},
"extract-i18n": {
"builder": "@angular-devkit/build-angular:extract-i18n",
"options": {
"browserTarget": "my-app:build"
}
"builder": "@angular-devkit/build-angular:extract-i18n"
},
"test": {
"builder": "@angular-devkit/build-angular:karma",
"options": {
"main": "src/test.ts",
"polyfills": "src/polyfills.ts",
"polyfills": [
"zone.js",
"zone.js/testing"
],
"tsConfig": "tsconfig.spec.json",
"karmaConfig": "karma.conf.js",
"inlineStyleLanguage": "scss",
"assets": [
"src/favicon.ico",
"src/assets"
{
"glob": "**/*",
"input": "public"
}
],
"styles": [
"src/styles.scss"
Expand All @@ -106,6 +98,5 @@
}
}
}
},
"defaultProject": "my-app"
}
}
44 changes: 0 additions & 44 deletions docs/ui/getting-started/demo/1__my-app/karma.conf.js

This file was deleted.

Loading

0 comments on commit b2cfec5

Please sign in to comment.