Template for application README file.

<< Insert Name >> Sample for ASP.NET Core

The << Insert Name >> is a RESTful API application, consisting of a server, built on ASP.NET Core and a client web application, built on << Insert Framework >>. This model allows for easy integration between the server and any modern UI frameworks such as Angular, React, Web Components, jQuery, etc.

While the << Insert Name >> server and client parts are configured to run together, each application has its own purpose and is agnostic to the other part, meaning that they are easily replaceable.

Starting the Application

• Press CTRL + F5 to run the project or press F5 to run it in debug mode.

If you get the "The Angular CLI process did not start listening for requests within the timeout period of 0 seconds" message, you will need to run the client app separately. Just open a new command prompt in the ClientApp dir and execute npm run start.

Application Structure

• The << Insert Name >> is a basic Web API created with ASP.NET Core 3.0+. << Insert Description >>
• The << Insert Name >> client is an << Insert Name >> web application. << Insert Description>>

The server application refers the client in the ClientApp dir by a submodule. This enables the two to run together, while making it easy to change either part. For example, you as a developer may create a client application on React in order to consume the same endpoint.

In order to use different client application, open the .csproj file and edit the URL of repository, where the client application lives:

<Target Name="DebugEnsureNodeEnv" BeforeTargets="Build" Condition=" '$(Configuration)' == 'Debug'">
    <Exec Condition="!Exists('$(SpaRoot)')" WorkingDirectory="$(SolutionDir)" Command="git clone -j8 https://github.com/IgniteUI/TaskPlanner.git ClientApp "/>
    <Exec Condition="Exists('$(SpaRoot)')" WorkingDirectory="$(SpaRoot)" Command="git pull origin master" />
    <Exec Condition="!Exists('$(SpaRoot)node_modules')" WorkingDirectory="$(SpaRoot)" Command="npm install" />
</Target>

The Exec commands are needed to:

1. Clone the client app repository
2. Pull changes
3. Execute npm install

Framework(s)

• Ignite UI for Angular
• Angular
• ASP.NET Core

Components Used

<< Update the list below with the components used in the client application >> Example: ButtonGroup

Industry

• << Insert Name, e.g. Project Manager Tooling>>