RecipEase

This is the RecipEase project for CPSC 471 Group 14.

Prerequisites

• Download the .NET 5.0 SDK
• Download MySQL
• (Optional) Run dotnet dev-certs https --trust in your terminal so that your browser doesn't think the development server is unsafe
  • You may have to close and reopen your browser to let this take effect
  • Note: this isn't supported on Linux
• Create a new MySQL user recipeaselocaluser with password recipeaselocalpw, see here
  • Give the user the "DBA" administrative role

Development

• Run dotnet watch --project ./Server/RecipEase.Server.csproj run to start the development server
  • Make sure this is run from the project root
  • Alternatively, run the watch task from VSCode

Updating the Database Schema

• Make any changes to the model files
• Ensure the EF command line tool is installed by running dotnet tool install --global dotnet-ef
• Drop the current database dotnet ef --project ./Server/RecipEase.Server.csproj database drop --force
• Update the database seeding code in Server/Data/DbInitializer.cs if necessary
• Restart the app

Note: it's also possible to use EF Migrations, but this app is just using fake seeded data so there's no need.

The schema can be dumped to a file with the following PowerShell command:

& 'C:\Program Files\MySQL\MySQL Server 8.0\bin\mysqldump.exe' -u root -p recipease > schema.sql

API Development

The API is contained in the Server folder and the logic is in the Controllers folder.

Once the dev server is started, go to https://localhost:5001/swagger/index.html for an interactive API explorer.

Controller Generation

First run

dotnet tool install -g dotnet-aspnet-codegenerator

Then to generate a controller for a model:

dotnet aspnet-codegenerator --project ./Server/RecipEase.Server.csproj controller -name <ControllerName> -async -api -m <ModelName> -dc RecipEaseContext -outDir Controllers

where you replace <ControllerName> with the name of controller class to be generated, and <ModelName> with the name of a model class from Shared/Models to generate the controller for. This will add the new controller to Server/Controllers.

API Reference Generation

To generate an API reference PDF, start the dev server, open api-ref-generate.html in your browser, disable CORS (see the link in the HTML for a suggestion on how to do this), and click the button.

Initial Project Creation

See here for details on how the project was initially scaffolded.

For adding Blazor WebAssembly the template code from the command dotnet new blazorwasm -ho -o AppName was used and integrated with the code from the above template.

VSCode Tips

• Install the C# extension (it's a workspace recommendation in this template)
  • See here for info about C# in VSCode
• When first opening the project VSCode will ask for permission to generate assets for building and debugging, approve this. If you miss this prompt, run the command .NET: Generate Assets for Build and Debug in the command palette.
• Add the following to your settings.json to use Emmet in C# HTML files

  "emmet.includeLanguages": {
      "aspnetcorerazor": "html"
  }

• Semantic highlighting for C# can be enabled in the VSCode settings.
• This project comes with a few VSCode Tasks for various development tasks, such as starting the dev server (the watch task)
• The project also has launch definitions for debugging the application

Resources

• EF Core with ASP .NET Tutorial
  • This project is based off of this tutorial
  • If you're using Visual Studio, that tutorial has instructions specific to Visual Studio that might be helpful
• ASP .NET Getting Started
• Debugging Blazor WASM
• Call Web API from Blazor WASM
• Blazor WASM form validation
• Web API apps in .NET