Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andfomin/NgProjectTemplate
Angular CLI templates for Visual Studio
https://github.com/andfomin/NgProjectTemplate
angular angular-cli visual-studio
Last synced: 7 days ago
JSON representation
Angular CLI templates for Visual Studio
- Host: GitHub
- URL: https://github.com/andfomin/NgProjectTemplate
- Owner: andfomin
- License: mit
- Created: 2017-06-14T20:49:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-02T01:17:07.000Z (about 6 years ago)
- Last Synced: 2024-10-04T14:07:55.256Z (about 1 month ago)
- Topics: angular, angular-cli, visual-studio
- Language: C#
- Homepage:
- Size: 153 KB
- Stars: 35
- Watchers: 6
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
This is a set of two separate templates that create Angular CLI applications in Visual Studio 2017. There is a template that adds the Angular CLI to an existing ASP.NET Core project. It is referred to as Item Template. Another template creates an Angular CLI application as a static website project. It is referred to as Project Template.
The Item Template adds an Angular CLI application to an existing ASP.NET Core 2.0 project. The main project launches the standard NG Development Server during development and routes requests to it, so the Angular application is available on the same port as the ASP.NET application. During a Release build and deployment, the template calls Angular CLI to build the application and copies the files over to the standard wwwroot folder to make them available at the same path as the path specified during development.
The project created by the Project Template is a customized ASP.NET Core project that hosts an Angular CLI application and is an adapter between the traditional development experience in Visual Studio and the infrastructure provided by Angular CLI. It deploys only the files produced by Angular CLI, but no any server-side assemblies, during publishing.
### Installing the templates
You can find the templates in Visual Studio 2017 by opening either the **New Item** dialog or the **New Project** dialog and navigating to the **Online** - **Templates** section. Use the Search box to look for "angular cli". Both the templates come packaged together in a single Visual Studio Extension file.
Alternatively, you can download the Extension file from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=AndreyFomin.AngularCLIProjectTemplate) and install it manually.
# The folowing topics are related to the Item Template.
If you select the "Add automatically" option in the dialog, the item template will do the following:
* Run `ng new {projectName} --directory . --routing --skip-git --skip-install` in the project's root directory.
* For Angular CLI 1.x: Add a `"baseHref"` property to the `"apps[0]"` object in the _.angular-cli.json_ file and assign either `"/"` for an Empty or WebAPI project or `"/ng/"` for an MVC or Razor Pages project to that property.
For Angular CLI 6: Add a `"baseHref"` property to the `{{projectName}}` object in the _angular.json_ file and assign either `"/"` for an Empty or WebAPI project or `"/ng/"` for an MVC or Razor Pages project to that property.
* If an existing _package.json_ is found, merge the _package.json_ file generated by the Angular CLI with it.
The actual installation of the npm packages does not happen at the time of the application creation, it will happen on next Build of the project.
* If an existing _.gitignore_ file is found, append Angular CLI entries to it.
* If an existing _tsconfig.json_ file is found, rename it to _tsconfig.json.old_ and replace it by the file generated by the Angular CLI.
* Add NuGet package [AfominDotCom.AspNetCore.AngularCLI](https://www.nuget.org/packages/AfominDotCom.AspNetCore.AngularCLI/) to the project.
That NuGet package is actually always added, even if you did not choose the Automatic Installation option.
* Modify the existing _Startup.cs_ file. Modify the `Configure` method. Insert the following code snippet at the end of the method in an WebAPI, MVC or Razor Pages project or before `app.Run(...)` in an Empty project. If no existing `app.UseStaticFiles()` call was found in the `Configure` method, uncomment the `app.UseStaticFiles();` line in the code snippet.
```csharp
if (env.IsDevelopment())
{
app.UseWebSockets().UseNgProxy();
}
else
{
// app.UseStaticFiles(); // Uncomment this line if it is not present somewhere else in the Configure method.
app.UseNgRoute();
}
```
### URL Path
The path specified as "baseHref" in the .angular-cli.json file, is a relative path.
For example, if your main ASP.NET Core website runs at http://localhost:12345 and the "baseHref" value is "/ng/", the Angular app will be served at http://localhost:12345/ng . Requests to that relative path will be proxied to the standard NG Development Server launched from the ASP.NET Core code. Please note, the proxy is used during development only.
### Deployment
During a Publish, the template looks up a script name in package.json corresponding to the Build Configuration, and if found, executes it. For example, if the Build Configuration name is "Release", it will look for a script named "build:Release".
If no corresponding script name is found, the default "build" script will be executed.
Then the template copies the files produced by the build script to a subfolder under the standard "wwwroot" directory, according to the relative path specified in the "baseHref" setting that was described above.
### Explanations of the messages that may be displayed in the dialog during an application creation
* The project references an unsupported version of ASP.NET Core.
[Learn more ...](https://github.com/andfomin/NgProjectTemplate/wiki/itemwiz-aspnetversion)
* This project has already got an Angular CLI application.
[Learn more ...](https://github.com/andfomin/NgProjectTemplate/wiki/itemwiz-gotng)
* This project has already got Angular npm packages installed.
[Learn more ...](https://github.com/andfomin/NgProjectTemplate/wiki/itemwiz-gotnpmangular)
* It looks like Angular CLI is not installed globally.
[Learn more ...](https://github.com/andfomin/NgProjectTemplate/wiki/itemwiz-nong)
* The existing file needs to be modified.
[Learn more ...](https://github.com/andfomin/NgProjectTemplate/wiki/itemwiz-fileopened)
* Add an Angular CLI application to the project automatically.
[Learn more ...](https://github.com/andfomin/NgProjectTemplate/wiki/itemwiz-options)
* An existing package.json file was found.
[Learn more ...](https://github.com/andfomin/NgProjectTemplate/wiki/itemwiz-mergepackagejson)
# The folowing topics are related to the Project Template.
Open the standard **New Project** dialog, navigate to Angular CLI Application template, specify the project name and its location, as well as whether to initialize a Git repository for the project.
To generate a project, you must have Angular CLI installed globally with npm as described [here](https://github.com/angular/angular-cli#installation). If Angular CLI is not available on your computer, you can still proceed with creating an empty project. To generate an Angular CLI application later on, execute `ng new -dir .` in the command line within the project directory.
You can customize your Angular CLI application by manually editing the *.angular-cli.json* configuration file or executing `ng set` in the command line window.
Angular CLI is a Node application which uses npm modules installed locally in the *node_modules* folder under the project root. The process of installing npm modules may take a few minutes depending on the network connection and the npm module cache. It is the longest part of creating the project. During a project creation, you will be presented with a dialog window where you can choose whether to create the project without actually installing npm modules. You will obviously need to install them at a same point later on.
A custom *.gitignore* file with combined settings for Visual Studio and Angular CLI is always added to the project root.
If you have decided to skip installing npm packages during a project creation, an initial npm install will be postponed until the first **Build** or **Run** of the project. An npm install will be executed during the first **Build** only if there is no *node_modules* folder found under the project root. That process uses the globally installed Node and npm executables.
If you have opted to install npm packages immediately after the project creation, the template will trigger an npm install. You might want to switch the **Output** window to the **Bower/npm** mode to observe the process.
Please note that regardless of your choice, Visual Studio may trigger npm install on opening of a project and as soon as you save any changes to the *package.json* file. This feature is described [here](https://webtooling.visualstudio.com/package-managers/npm/). To control this feature, navigate in the IDE to **Tools > Options > Projects and Solutions > Web Package Management > Package Restore**.
The version of npm preinstalled with Visual Studio 2017 apparently meets the Angular CLI requirements. But the version of the Node.js executable which is preinstalled with Visual Studio 2017 does not entirely satisfy the Angular CLI requirements. As a result, you may see non-critical warnings during Angular CLI installation. If you want to use the globally installed Node and npm in Visual Studio, you can find the instructions [here](https://blogs.msdn.microsoft.com/webdev/2015/03/19/customize-external-web-tools-in-visual-studio-2015/)
### Running the project.
Run the project by pressing **F5**. The project is started by Visual Studio as an ASP.NET Core application which in turn launches the genuine Angular CLI Development Server, redirects the launched web browser to it and exits afterwards.
This project relies on the default hosting settings stored in the *Properties\launchSettings.json* file. That file is controlled by Visual Studio, do not edit it manually. Its contents correspond to the **Debug** tab on the project's **Properties** dialog page. Make sure the **IIS Express** profile is selected as active. Although that is the default setting, sometimes the other profile may unexpectedly get active. That would cause no problem, but confusion when starting the project.
NG Development Server uses port 4200 by default. If that port is already in use, you may want to specify a different port. To do that, open the project's **Properties** page and select the **Debug** tab. Add an Environment Variable named `ASPNETCORE_NgServeOptions` and enter `--port Number` (for example `--port 4201`) as its Value. The Value stored in `ASPNETCORE_NgServeOptions` is passed to `ng serve` as is. You can use that setting to customize the NG Development Server. Find more about the options available in `ng serve` [here](https://github.com/angular/angular-cli/wiki/serve).
Since the project does not have server-side code to debug and since Angular CLI does not support the JavaScript Debugging feature in Visual Studio anyway, you might prefer to start the project without debugging by pressing **Ctrl+F5** in Visual Studio instead and then open Developer Tools by pressing **F12** in the browser.
Alternatively, you may want to disable JavaScript debugging in Visual Studio by going to **Tools -> Options -> Debugging -> General** and turning off the setting **Enable JavaScript Debugging for ASP.NET (Chrome and IE)**. Learn more about JavaScript debugging in Visual Studio [here](https://aka.ms/chromedebugging). If you keep the JavaScript Debugging feature in Visual Studio enabled, then you may face the following effects:
* Opening Developer Tools in Chrome stops the script debugging session
* The Hot Module Replacement feature of Angular CLI breaks code mapping
* If you close the browser window manually, then stopping the debugger in Visual Studio will take longer than usual.
### Building and publishing the Angular application.
The project executes `npm run build` during a **Publish** process. You can customize the build options by editing the predefined **build** task in the *package.json* file.
Only the files produced by Angular CLI during the build are published to the target destination.
To start a publish, right-click the project in **Solution Explorer** and choose **Publish** in the pop-up menu. Select a desired publish target on the dialog page and proceed according to your selection. The project template was tested by publishing to a local folder and to Azure App Service.
As a side note, Azure App Service supports hosting of static web sites without any additional configuration or modification. Learn more [here](https://www.microsoft.com/middleeast/azureboxes/cloud-hosting-for-a-static-website.aspx) and [here](https://docs.microsoft.com/en-us/azure/app-service-web/app-service-web-get-started-html)
### Have fun
As a demonstration of how it is really easy to use the tempate, I have created a video [Create an Angular app and publish it on the web in four minutes without touching the keyboard!](https://www.youtube.com/watch?v=yeiNhJb-524) [](https://www.youtube.com/watch?v=yeiNhJb-524)