run_locally.md

Running the app locally

It is helpful to be able to experiment locally, so it's worth having a go at the below, but getting the app running is not required for the exercise. If you are having trouble with it then feel free to skip onto the next part of the exercise.

Build

1. Run dotnet build from the terminal in the project folder. This will build the C# code.
   • If you get errors resolving NuGet packages try running dotnet nuget add source https://api.nuget.org/v3/index.json -n nuget.org to add the main NuGet registry as a package source. You can use dotnet nuget list source to see what package sources NuGet is using.
2. From the DotnetTemplate.Web folder, run npm install (first time only) and then npm run build. This will install dependencies and then build the TypeScript code.
   • If you are on Windows and see errors during installation containing "gyp ERR", you may need to first run npm install --global windows-build-tools (and restart your terminal).
   • npm ci is another way of installing dependencies that will strictly follow the versions listed in package-lock.json. So this can be used for completely reproducible builds.

Test

1. Run dotnet test inside the project folder. This will run the C# tests in the DotnetTemplate.Web.Tests project.
2. Run npm t inside the DotnetTemplate.Web folder. This will run the TypeScript tests in DotnetTemplate.Web/Scripts/spec. They're run using Jasmine.
3. Run npm run lint inside the DotnetTemplate.Web folder. This will run linting on the TypeScript code, using eslint. Linting refers to checking the codebase for mistakes, either functional or stylistic. This project's linting currently reports zero errors, two warnings.

Run

1. Run dotnet run in the DotnetTemplate.Web folder. This will start the app.
2. You can now see the website by going to http://localhost:5000/. You should see something like the image below.