Development Guide

This guide provides instructions for building, running, and testing the IGP Fan Reference project.

Prerequisites

.NET 8.0 or 10.0 SDK
PowerShell (for running scripts)
Node.js (required for Playwright tests)

Getting Started

Clone the repository:

git clone <repository-url>
cd IGP-Fan-Reference

Restore dependencies:
```
dotnet restore
```
Run the application: Navigate to the IGP project folder and run:
```
cd IGP
dotnet watch run
```
The application will be available at https://localhost:5001 (or the port specified in your output).

Running Tests

The project uses Playwright for E2E testing, located in the TestAutomation project.

Install Playwright browsers:

dotnet build TestAutomation
pwsh TestAutomation/bin/Debug/net8.0/playwright.ps1 install

Execute tests:
```
dotnet test TestAutomation
```

Project Structure and Maintenance

Adding a new Unit/Building: Update the Entity models and data providers in the Model project.
Modifying UI: Most common UI elements are in the Components library or the IGP/Pages directory.
Business Logic: Changes to game mechanics or calculations should be made in Services.Immortal.

Deployment

The site is configured as a Static Web App. Deployment settings can be found in staticwebapp.config.json and the .github/workflows directory for automated CI/CD.

1.6 KiB Raw Blame History