Skip to content

Commit 6cae0cc

Browse files
committed
Update docs for .net core release
1 parent c1433c0 commit 6cae0cc

8 files changed

+136
-156
lines changed

doc/Development-Guide-Angular.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -727,11 +727,11 @@ <h4>Authentication</h4>
727727
<p>We suggest you to disable two factor authentication for the user which will
728728
be used for remote authentication. Otherwise, two factor authentication flow
729729
should be implemented by the client. You can check account module source code to
730-
understand the flow.</p>
731-
<p>We assume that you disable two factor authentication for the <strong>admin</strong>
730+
understand the flow. We assume that you have disabled two factor authentication for the <strong>admin</strong>
732731
user of <strong>default</strong> tenant since we will use it in this sample.</p>
733732
<p>Following headers should be configured for all requests (Abp.TenantId is Id
734-
of the default tenant. This is not required for single tenant applications):</p>
733+
of the default tenant. This is not required for single tenant applications or if
734+
you want to work with host users):</p>
735735
<p>
736736
<img alt="Postman auth headers" height="112" src="images/postman-ng2-auth-headers.png" width="523" /></p>
737737
<p>Then we can send username and password as a <strong>POST</strong> request to

doc/Development-Guide-Core.html

Lines changed: 111 additions & 109 deletions
Large diffs are not rendered by default.

doc/Getting-Started-Angular.html

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,18 @@ <h3 id="DocCreateProject">Create a Project</h3>
2929
<p>
3030
<img class="img-thumbnail" alt="Client Server folders" height="54" src="images/client-server-folders.png" width="70" /></p>
3131
<ul>
32-
<li>Client folder contains the <a href="Development-Guide-Angular.html">
32+
<li><strong>angular</strong> folder contains the <a href="Development-Guide-Angular.html">
3333
Angular application</a> which is configured to work with
3434
<a href="https://cli.angular.io/" target="_blank">angular-cli</a>.</li>
35-
<li>Server folder contains the <a href="Development-Guide-Core.html">server
35+
<li><strong>aspnet-core</strong> folder contains the <a href="Development-Guide-Core.html">server
3636
side</a> ASP.NET Core solution and configured to work with
3737
<a href="https://www.visualstudio.com/vs/community/" target="_blank">Visual
3838
Studio</a>.</li>
3939
</ul>
4040
<h4>Merging Client and Server Solutions</h4>
4141
<p>
42-
Client and Server solutions are designed to work separately by default but if you want to work on a single Visual Studio solution, you can read <a href="Merge-Angular-Client-Server">Merging Angular 2.x Client and Server solution</a> document.
42+
Client and Server solutions are designed to work separately by default but if you want to work on a single Visual Studio solution, you can read <a href="Merge-Angular-Client-Server">
43+
Merging Angular Client and Server solution</a> document.
4344
</p>
4445
<h3>ASP.NET Core Application</h3>
4546
<p>When you open Server side solution in <strong>Visual Studio 2017+</strong>, you will see the
@@ -68,11 +69,9 @@ <h5>AspNet Zero Migrator Application</h5>
6869

6970
<h5>Entity Framework Migration Command</h5>
7071

71-
<p>You can also use Entity Framework's built-in command line tools for migrations.</p>
72-
73-
<p>Open <strong>Windows Command Prompt</strong>, locate to the folder containing
74-
the <strong>.EntityFramework</strong> project and run the "<strong>dotnet ef
75-
database update</strong>" command as shown below:</p>
72+
<p>You can also use Entity Framework's built-in tools for migrations. Open
73+
<strong>Package Manager Console</strong> in Visual Studio, set<strong> .</strong>EntityFrameworkCore
74+
as the <strong>Default Project</strong> and run the <strong>Update-Database</strong> command as shown below:&nbsp;</p>
7675
<p>
7776
<img class="img-thumbnail" alt="dotnet ef database update" height="27" src="images/dotnet-ef-database-update.png" width="499" /></p>
7877

@@ -91,11 +90,10 @@ <h4 id="DocConfigureMultiTenancy">Multi-Tenancy</h4>
9190
<p>ASP.NET Zero supports multi-tenant and single-tenant applications.
9291
Multi-tenancy is <strong>enabled by default</strong>. If you don't have idea
9392
about multi-tenancy or don't want to create a multi-tenant application, you can
94-
<strong>disable</strong> it. If you
95-
want a multi-tenant application, leave it <strong>enabled</strong> in ProjectName<strong>CoreModule</strong>
96-
class in <strong>.Core</strong> project:</p>
97-
<pre lang="cs">//Enable this line to create a multi-tenant application.
98-
<strong>Configuration.MultiTenancy.IsEnabled</strong> = true;</pre>
93+
<strong>disable</strong> it by setting <strong>
94+
AbpZeroTemplateConsts.MultiTenancyEnabled</strong> to false in the .Core
95+
project.</p>
96+
<h4>Run API Host</h4>
9997

10098
<p>Once you've done the configuration, you can run the application. Server side
10199
application only contains APIs. So, default page is a swagger UI which can be
@@ -109,15 +107,15 @@ <h4>Prerequirements</h4>
109107
<li><a href="https://nodejs.org/en/download/" target="_blank">nodejs</a>
110108
6.9+ with npm 3.10+</li>
111109
<li>Typescript 2.0+</li>
110+
<li><a href="https://yarnpkg.com/">yarn</a></li>
112111
</ul>
113112
<h4>Restore Packages</h4>
114113
<p>Locate to the Client folder, open a command line and run the following command to restore packages:</p>
115114
<pre>yarn</pre>
116115
<p>We suggest to use
117-
<a href="https://yarnpkg.com/" target="_blank">yarn</a> because npm has some problems, yarn solves those problems and it is compatible with npm as well. Alternatively, you can use npm to restore packages. If you want to use npm, you need to run</p>
118-
<pre>npm install</pre>
119-
<p>Notice that npm install may show some warn messages, which is not related to
120-
our solution and generally it's not a problem.</p>
116+
<a href="https://yarnpkg.com/" target="_blank">yarn</a> because npm has some problems.
117+
It is slow and can not consistently resolve dependencies, yarn solves those problems and it is compatible
118+
to npm as well.</p>
121119
<h4>Run The Application</h4>
122120

123121
<p>
@@ -145,13 +143,6 @@ <h4>Application UI</h4>
145143
see the sample dashboard screen:</p>
146144
<p>
147145
<img class="img-thumbnail" alt="Dashboard screen" height="870" src="images/dashboard.png" width="1339" /></p>
148-
<h4>Time Zone Setting</h4>
149-
<p>Remember to adjust your time zone in Settings page (available to the host
150-
admin) in order to see date and
151-
times in your local time. Default time zone is <strong>UTC</strong>. See
152-
<a href="http://www.aspnetboilerplate.com/Pages/Documents/Timing">timing
153-
documentation</a> to learn more about timing infrastructure.</p>
154-
155146
<h3 id="DocMore">More</h3>
156147

157148
<p>Your solution is up and working.

doc/Getting-Started-Core.html

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,9 @@ <h5>AspNet Zero Migrator Application</h5>
5454

5555
<h5>Entity Framework Migration Command</h5>
5656

57-
<p>You can also use Entity Framework's built-in command line tools for migrations.</p>
58-
59-
<p>Open <strong>Windows Command Prompt</strong>, locate to the folder containing
60-
the <strong>.EntityFramework</strong> project and run the "<strong>dotnet ef
61-
database update</strong>" command as shown below:</p>
57+
<p>You can also use Entity Framework's built-in tools for migrations. Open
58+
<strong>Package Manager Console</strong> in Visual Studio, set<strong> .</strong>EntityFrameworkCore
59+
as the <strong>Default Project</strong> and run the <strong>Update-Database</strong> command as shown below:&nbsp;</p>
6260
<p>
6361
<img class="img-thumbnail" alt="dotnet ef database update" height="27" src="images/dotnet-ef-database-update.png" width="499" /></p>
6462

@@ -69,19 +67,17 @@ <h5>Entity Framework Migration Command</h5>
6967
<p>
7068
You can use EF console commands for development and Migrator.exe for
7169
production. But notice that; Migrator.exe supports running migrations in
72-
multiple databases at once, which can be useful in development/production for
70+
multiple databases at once, which is very useful in development/production for
7371
multi tenant applications.</p>
7472

7573
<h4 id="DocConfigureMultiTenancy">Multi-Tenancy</h4>
7674

7775
<p>ASP.NET Zero supports multi-tenant and single-tenant applications.
7876
Multi-tenancy is <strong>enabled by default</strong>. If you don't have idea
7977
about multi-tenancy or don't want to create a multi-tenant application, you can
80-
<strong>disable</strong> it. If you
81-
want a multi-tenant application, leave it <strong>enabled</strong> in ProjectName<strong>CoreModule</strong>
82-
class in <strong>.Core</strong> project:</p>
83-
<pre lang="cs">//Enable this line to create a multi-tenant application.
84-
<strong>Configuration.MultiTenancy.IsEnabled</strong> = true;</pre>
78+
<strong>disable</strong> it by setting <strong>
79+
AbpZeroTemplateConsts.MultiTenancyEnabled</strong> to false in the .Core
80+
project.</p>
8581

8682
<h3 id="DocRunProject">Run The Project</h3>
8783

@@ -98,12 +94,6 @@ <h3 id="DocRunProject">Run The Project</h3>
9894
see the sample dashboard screen:</p>
9995
<p>
10096
<img class="img-thumbnail" alt="Dashboard screen" height="870" src="images/dashboard.png" width="1339" /></p>
101-
<h4>Time Zone Setting</h4>
102-
<p>Remember to adjust your time zone in Settings page in order to see date and
103-
times in your local time. Default time zone is <strong>UTC</strong>. See
104-
<a href="http://www.aspnetboilerplate.com/Pages/Documents/Timing">timing
105-
documentation</a> to learn more about timing infrastructure.</p>
106-
10797
<h3 id="DocMore">More</h3>
10898

10999
<p>Your solution is up and working.

doc/Getting-Started-Mvc-Angularjs.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,6 @@ <h3 id="DocRunProject">Run The Project</h3>
101101
<strong>empty</strong>
102102
in login screen and use <strong>admin</strong> as user name and <strong>123qwe</strong> as password to login as
103103
<strong>host admin</strong>.</p>
104-
<h4>Time Zone Setting</h4>
105-
<p>Remember to adjust your time zone in Settings page in order to see date and
106-
times in your local time. Default time zone is <strong>UTC</strong>.</p>
107104

108105
<h3 id="DocMore">More</h3>
109106

29.9 KB
Loading
186 KB
Loading
110 KB
Loading

0 commit comments

Comments
 (0)