First look at Razor Pages

In this section, you will be shown how to use the .NET Core command line tools to create a simple Razor Pages application and how to build and run it in the browser. You will also explore the various parts of the application and understand the role that each part plays.

Try it out: creating your first Razor Pages application

  1. If you haven't already done so, download the latest version of the .NET Core SDK.

  2. Open your preferred command line tool (cmd.exe or Powershell in Windows; Terminal on a Mac; Bash or similar on Linux) and enter dotnet --version.

  3. Check the output to confirm that your version of .NET Core is at least 2.0.

    Dotnet Version

  4. Navigate to a suitable location for your application if needed and then type mkdir RazorPages to create a folder for your application's files.

  5. Type cd RazorPages to enter the application folder.

  6. Type dotnet new razor. This command generates the application files from the basic site template. You should receive confirmation that the site was created and that the dotnet restore command is being run. The dotnet restore command looks at the dependencies required for the application and obtains them from NuGet.

    dotnet new razor

  7. Type dotnet run which compiles the application and launches it on port 5000:

    dotnet run

  8. Open you preferred browser and navigate to http://localhost:5000. The web site should appear:

    Default template

Visual Studio

If you are using Visual Studio, choose Create New Project from the start screen

Create New Project

Choose ASP.NET Core Web Application from the project options:

Template options

Amend the project name options and the location where the project files will be created to suit your needs.

Next, select Web Application from the template options that appear:

Web Application Options

This will result in a new Razor Pages application being created which should be identical to the one generated via the command line.

Anatomy of a Razor Pages application

A Razor Pages application comprises many folders and files. In the next section, you will explore the files that were generated when you created, restored, compiled and ran the application in the previous section. Here is an explorer view of the application folder structure followed by a closer look at each folder or group of files. Prior to .NET 6, the project template included an extra C# code file, Startup.cs:

Razor Pages file structure

Razor Pages file structure

Pages folder

Pages Folder

The Pages folder is the default location for Razor Pages files. The files ending with .cshtml are Razor files. Other files, ending with .cs are C# class files. These are paired with Razor files and are known as PageModel files. Not all Razor files have a matching class file. Some Razor files have a leading underscore (_) in their file name. These files are not browsable, but they perform distinct roles as part of a Razor Pages application. You can read more about these special Razor files and their roles.

wwwroot folder

wwwroot folder in Razor Pages

The wwwroot folder is where static files are placed in a .NET Core web application. These files include the CSS style sheets, images and JavaScript files used by the site. An additional folder named lib contains third party client-side packages. These packages are managed by LibMan, the default client-side package manager for Razor Pages and MVC applications.

lib Folder

lib folder in Razor Pages

The third party client side packages included as part of the template are:

  • BootStrap: a UI framework built by a team at Twitter that reduces the work required to design site layouts, and also includes a range of built-in styles for components such as buttons, forms, tables, inputs and so on. In Razor Pages 3.x, the version of Bootstrap is 4. It was replaced with version 5 in .NET 6.
  • jQuery: a JavaScript library that BootStrap 4 and Razor Pages client side validation relies on.
  • jQuery Validation: a jQuery plugin for client-side validation of forms
  • jQuery Unobtrusive Validation: another jQuery validation plugin designed by the ASP.NET team to work specifically with form inputs generated by Razor helpers.

Root files

A number of files reside in the root folder.

Razor Pages root files

File Description
appsettings.json A json-based file for application-wide configuration settings
appsettings.Development.json A json-based file for application-wide configuration settings that only take effect during development
Program.cs The entry point for the Razor Pages application
RazorPages.csproj An XML-based file that contains information about the project and is used by the MSBuild system for compilation and publishing

Razor Pages root files

File Description
appsettings.json A json-based file for application-wide configuration settings
appsettings.Development.json A json-based file for application-wide configuration settings that only take effect during development
Program.cs The entry point for the Razor Pages application
RazorPages.csproj An XML-based file that contains information about the project and is used by the MSBuild system for compilation and publishing
Startup.cs The Startup class configures the service container and the request pipeline that handles all requests made to the application

Bin folder

Razor Pages bin folder

The bin folder is the default output location for binary files generated when the application is compiled. Typically, this folder contains two sub-folders, Debug and Release. The first is for the binaries that result from compiling the application in Debug mode, and the second is where binaries generated from a compilation in Release mode are placed. Both of these folders contain a subfolder named netcoreapp[version number], where [version number] represents the version of .NET Core used to create the application. If you are using .NET Core 3.1, for example, the folder name will be netcoreapp3.1. The files that you see in the image above are from /bin/Debug/netcoreapp3.1/

Obj folder

obj Folder

The Obj folder is used to store temporary object files and other files that are used to create the final binary during the compilation process.

Last updated: 10/12/2022 08:18:19

© 2018 - 2024 - Mike Brind.
All rights reserved.
Contact me at Outlook.com