From d9ef6fa0edb57194191989439bf5c28a8fe8a3f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Fri, 18 Sep 2020 11:46:38 +0300 Subject: [PATCH] Working on the blazor getting started --- docs/en/Getting-Started.md | 44 ++++++++++++++++++-------------------- docs/en/docs-params.json | 1 + 2 files changed, 22 insertions(+), 23 deletions(-) diff --git a/docs/en/Getting-Started.md b/docs/en/Getting-Started.md index 55fcafe132..4cc3a6e68c 100644 --- a/docs/en/Getting-Started.md +++ b/docs/en/Getting-Started.md @@ -3,13 +3,13 @@ ````json //[doc-params] { - "UI": ["MVC","NG"], + "UI": ["MVC", "Blazor", "NG"], "DB": ["EF", "Mongo"], "Tiered": ["Yes", "No"] } ```` -This tutorial explains how to create a new {{if UI == "MVC"}} ASP.NET Core MVC (Razor Pages) web {{else if UI == "NG"}} Angular {{end}} application using the startup template. +This tutorial explains how to create a new web application using the [application startup template](Startup-Templates/Application.md). ## Setup Your Development Environment @@ -20,11 +20,11 @@ First things first! Let's setup your development environment before creating the The following tools should be installed on your development machine: -* [Visual Studio 2019 (v16.4+)](https://visualstudio.microsoft.com/vs/) for Windows / [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/). [1](#f-editor) +* [Visual Studio 2019](https://visualstudio.microsoft.com/vs/) for Windows / [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/). [1](#f-editor) * [.NET Core 3.1+](https://www.microsoft.com/net/download/dotnet-core/) -* [Node v12 or v14](https://nodejs.org/en/) -* [Yarn v1.20+ (not v2)](https://classic.yarnpkg.com/en/docs/install) [2](#f-yarn) or npm v6+ (installed with Node) +* [Node v12 or v14](https://nodejs.org/) +* [Yarn v1.20+ (not v2)](https://classic.yarnpkg.com/en/docs/install) [2](#f-yarn) or npm v6+ (already installed with Node) {{ if Tiered == "Yes" }} * [Redis](https://redis.io/) (the startup solution uses the Redis as the [distributed cache](Caching.md)). @@ -37,7 +37,7 @@ The following tools should be installed on your development machine: ### Install the ABP CLI -[ABP CLI](./CLI.md) is a command line interface that is used to automate some common tasks for ABP based applications. +[ABP CLI](./CLI.md) is a command line interface that is used to automate some common tasks for ABP based solutions. > ABP CLI is a free & open source tool for the ABP framework. @@ -62,31 +62,21 @@ dotnet tool update -g Volo.Abp.Cli Use the `new` command of the ABP CLI to create a new project: ````shell -abp new Acme.BookStore{{if UI == "NG"}} -u angular {{end}}{{if DB == "Mongo"}} -d mongodb{{end}}{{if Tiered == "Yes" && UI != "NG"}} --tiered {{else if Tiered == "Yes" && UI == "NG"}}--separate-identity-server{{end}} +abp new Acme.BookStore{{if UI == "NG"}} -u angular {{else if UI == "Blazor"}} -u blazor {{end}}{{if DB == "Mongo"}} -d mongodb{{end}}{{if Tiered == "Yes"}}{{if UI == "MVC"}} --tiered {{else}} --separate-identity-server{{end}}{{end}} ```` -{{ if UI == "NG" }} - -* `-u` argument specifies the UI framework, `angular` in this case. - {{ if Tiered == "Yes" }} -* `--separate-identity-server` argument is used to separate the identity server application from the API host application. If not specified, you will have a single endpoint on the server. - -{{ end }} +{{ if UI == "MVC" }} -{{ end }} +* `--tiered` argument is used to create N-tiered solution where authentication server, UI and API layers are physically separated. -{{ if DB == "Mongo" }} +{{ else }} -* `-d` argument specifies the database provider, `mongodb` in this case. +* `--separate-identity-server` argument is used to separate the identity server application from the API host application. If not specified, you will have a single endpoint on the server. {{ end }} -{{ if Tiered == "Yes" && UI != "NG" }} - -* `--tiered` argument is used to create N-tiered solution where authentication server, UI and API layers are physically separated. - {{ end }} > You can use different level of namespaces; e.g. BookStore, Acme.BookStore or Acme.Retail.BookStore. @@ -113,12 +103,20 @@ You will see the following solution structure when you open the `.sln` file in t {{else}} -![vs-default-app-solution-structure](images/vs-app-solution-structure{{if Tiered == "Yes"}}-tiered{{end}}.png) +{{if Tiered == "Yes"}} + +![vs-default-app-solution-structure](images/vs-app-solution-structure-tiered.png) + +{{else}} + +![vs-default-app-solution-structure](images/vs-app-solution-structure.png) + +{{end}} {{end}} {{ else if UI == "NG" }} -There are three folders in the created solution: +There are two folders in the created solution: ![](images/solution-files-non-mvc.png) diff --git a/docs/en/docs-params.json b/docs/en/docs-params.json index 23d079f9bb..f28a3b49ef 100644 --- a/docs/en/docs-params.json +++ b/docs/en/docs-params.json @@ -5,6 +5,7 @@ "displayName": "UI", "values": { "MVC": "MVC / Razor Pages", + "Blazor": "Blazor", "NG": "Angular" } },