Skip to content

Commit 236958c

Browse files
committed
Updated angular 2 doc for v4 release
1 parent 6cae0cc commit 236958c

File tree

2 files changed

+44
-14
lines changed

2 files changed

+44
-14
lines changed

doc/Development-Guide-Angular.html

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ <h4>About This Document</h4>
2424
<h4>Pre Requirements</h4>
2525
<p>Following tools are needed in order to use the solution:</p>
2626
<ul>
27-
<li>Nodejs 6.9+ and Npm 3.10+</li>
28-
<li>Typescript 2.0+</li>
27+
<li><a href="https://nodejs.org" target="_blank">Nodejs 6.9+ and Npm 3.10+</a></li>
28+
<li><a href="https://www.typescriptlang.org/" target="_blank">Typescript 2.0+</a></li>
29+
<li><a href="https://yarnpkg.com/lang/en/" target="_blank">Yarn</a></li>
2930
</ul>
3031
<p>In addition, see <a href="Development-Guide-Core.html">AspNet Core</a>
3132
documentation for server side requirements.</p>
@@ -137,10 +138,6 @@ <h4>Configuration</h4>
137138
<li>We should configure IIS to bind this static IP to our application.</li>
138139
</ol>
139140
<p>There may be other ways of doing it but this is the most simple way.</p>
140-
<h4>Workarounds</h4>
141-
<p>As Angular 2 is pretty new, it has some shortcomings (and third party
142-
angular2 modules we used). Especially, Angular-cli is still in beta. So, AspNet
143-
Zero has some minor workarounds those can be seen in the code base.</p>
144141
<h3>AccountModule</h3>
145142
<p><strong>AccountModule</strong> provides <strong>login</strong>, <strong>register</strong>,
146143
<strong>forgot password </strong>and <strong>email activation</strong> pages and
@@ -532,6 +529,12 @@ <h5>Enabling LDAP (Active Directory) Authentication</h5>
532529
system, then generally even <strong>no need</strong> to set Domain name, user and password. You
533530
can logout and then login with your <strong>domain user name and password</strong>.
534531
If not, you should set these credentials.</p>
532+
<div class="bs-callout bs-callout-warning">
533+
<p><strong>.Net Core Compability</strong></p>
534+
<p>LDAP Authentication is not supportted by .net core yet. Thus, it's designed
535+
to be conditional. If you are using .Net Framework (4.6+) then it will be
536+
available, otherwise it will be disabled.</p>
537+
</div>
535538
<h4>Maintenance</h4>
536539
<p>Maintenance page is available to <strong>host side</strong> for multi tenant
537540
applications (for single tenant applications it's shown in tenant side) and shown as
@@ -573,6 +576,11 @@ <h5>Notification List</h5>
573576
<p>All notifications of the user are listed in this page.</p>
574577
<p>
575578
<img class="img-thumbnail" alt="Notification list" height="313" src="images/notifications-list-core.png" width="774" /></p>
579+
<div class="bs-callout bs-callout-warning">
580+
<p><strong>.Net Core Compability</strong></p>
581+
<p>Since SignalR is not ready yet for .net core, real time notifications will
582+
not work if you select .net core as your base framework.</p>
583+
</div>
576584

577585
<h4>Chat</h4>
578586
<p>Chat icon is located next to user's profile image on top right corner of the page. The number in the red circle shows total unread chat message count.</p>
@@ -590,6 +598,11 @@ <h5>Chat Features</h5>
590598
<img class="img-thumbnail" alt="User menu" src="images/chat-features.png" />
591599
<p>There are three chat features in the system. These are "Chat", "Chat with host", "Chat with other tenants". These features can be enabled/disabled
592600
per edition/tenant. By using these features host can enable/disable chat with other tenant's users or host users.</p>
601+
<div class="bs-callout bs-callout-warning">
602+
<p><strong>.Net Core Compability</strong></p>
603+
<p>Since SignalR is not ready yet for .net core, chat feature will
604+
not work if you select .net core as your base framework.</p>
605+
</div>
593606
<h4>User Menu</h4>
594607
<p>A user can click his name at top right corner to open user menu:</p>
595608
<p>
@@ -622,7 +635,7 @@ <h4>NPM Packages</h4>
622635
<p>ASP.NET Zero solution supports both <a href="https://yarnpkg.com/" target="_blank">
623636
yarn</a> and <a href="https://www.npmjs.com/" target="_blank">
624637
npm</a> to obtain front end library dependencies (like angular and bootstrap). We suggest to use yarn because npm has some problems, yarn solves those problems and it is compatible with npm as well. You can easily add, update or remove packages
625-
on yarn's or npm's command line interface.</p>
638+
on yarn's command line interface.</p>
626639
<h4>Angular CLI &amp; WebPack</h4>
627640
<p>AspNet Zero uses <a href="https://cli.angular.io/" target="_blank">
628641
angular-cli</a> for the development and deployment. It's properly configured for
@@ -643,9 +656,13 @@ <h4>NSwag</h4>
643656
<p>Generated code is located in shared/service-proxies/<strong>service-proxies</strong>.ts
644657
file. You should not make manual change in this file since it will be overritten
645658
on the next code generation.</p>
659+
<div class="bs-callout bs-callout-warning">
660+
<p><strong>Refreshing Service Proxies</strong></p>
646661
<p>While Nswag automatically generate proxy files, it does not refresh <strong>
647662
service-proxies.module</strong>.ts. If you add a new service, you should <strong>
648-
manually</strong> add it to this file as like others.</p>
663+
manually</strong> add it to this file as like others.&nbsp;</p>
664+
</div>
665+
649666
<h4>AppComponentBase</h4>
650667
<p>If you inherit your components from <strong>AppComponentBase</strong> class,
651668
you can get many commonly used services as pre-injected (like localization,
@@ -655,7 +672,7 @@ <h4>AppComponentBase</h4>
655672
function in component classes for localization. See pre-built components for
656673
example usages.</p>
657674
<h4>Localization</h4>
658-
<p>ASP.NET Zero strong>User Interface</strong> is completely
675+
<p>ASP.NET Zero <strong>User Interface</strong> is completely
659676
localized. AspNet Zero uses <strong>dynamic, database based, per-tenant</strong>
660677
localization.</p>
661678
<p>XML files are used as base translation for desired languages (defined in the
@@ -682,7 +699,7 @@ <h4>Exception Handling</h4>
682699
exception handling</a> system. Thus, you don't need to handle &amp; care about
683700
exceptions in most time. All server side exceptions are gracefuly handled and an
684701
appropriate message is shown to the user.</p>
685-
<h4>AAuthorization</h4>
702+
<h4>Authorization</h4>
686703
<p>You can inject and use PermissionCheckerService to check user permissions.
687704
It's pre injected for AppComponentBase (permission field) and also you can use
688705
shortcut isGranted function. Permissions are defined in
@@ -715,6 +732,10 @@ <h4>SignalR Integration</h4>
715732
<p>See
716733
<a href="http://www.aspnetboilerplate.com/Pages/Documents/SignalR-Integration">
717734
SignalR integration</a> document for more information.</p>
735+
<div class="bs-callout bs-callout-warning">
736+
<p><strong>.Net Core Compability</strong></p>
737+
<p>Since SignalR is not ready yet for .net core, SignalR integration is disabled if you select .net core as your base framework.</p>
738+
</div>
718739
<h3>Token Based Authentication</h3>
719740
<p>AspNet Zero Angular UI uses the <a href="Development-Guide-Core.html">server
720741
side</a> via token based authentication. Any application can authenticate and
@@ -763,9 +784,12 @@ <h3>Swagger UI</h3>
763784
<img class="img-thumbnail" alt="Swagger UI" height="837" src="images/swagger-ui-ng2.png" width="973" /></p>
764785
<h3>
765786
Deployment</h3>
787+
<div class="bs-callout bs-callout-warning">
788+
<p><strong>About Deployment</strong></p>
766789
<p>
767-
<em>If you want to merge and deploy Angular 2 UI to the ASP.NET Core backend,
768-
you can follow this </em><a href="Merge-Angular-Client-Server.html"><em>tutorial</em></a><em>.</em></p>
790+
If you want to merge and deploy Angular 2 UI with the ASP.NET Core backend,
791+
you can follow this <a href="Merge-Angular-Client-Server.html">tutorial</a>.</p>
792+
</div>
769793
<p>
770794
We are using <a href="https://cli.angular.io/" target="_blank">angular-cli</a>
771795
for development &amp; deployment. Angular CLI has it's own build command that can be

doc/Development-Guide-Core.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -945,8 +945,14 @@ <h4>Background Jobs And HangFire</h4>
945945
<p>ABP framework contains a <strong>background job system</strong> with a
946946
<strong>default</strong> background job
947947
manager. If you want to use <a href="http://hangfire.io/" target="_blank">Hangfire</a> as your background job manager, you can
948-
easily enable it. Just uncomment AddHangfire and UserHangfire lines in
949-
Startup.cs (of Web.Mvc or Web.Host depending on your case).</p>
948+
easily enable it;</p>
949+
<ol>
950+
<li>Uncomment <strong>AddHangfire</strong> and <strong>UseHangfireDashboard</strong>
951+
and <strong>UseHangfireServer</strong> lines in
952+
Startup.cs (of Web.Mvc or Web.Host depending on your case).</li>
953+
<li>Uncomment Configuration.BackgroundJobs.UseHangfire in
954+
...WebCoreModule.cs class in your .Web.Core project.</li>
955+
</ol>
950956
<p><strong>Note</strong>: Hangfire creates it's <strong>own tables</strong> in
951957
the database on first run. See
952958
<a href="http://www.aspnetboilerplate.com/Pages/Documents/Background-Jobs-And-Workers">

0 commit comments

Comments
 (0)