Building and Running the Application

Prerequisites

.NET 10 SDK
Node.js and npm (Node 20.19+ or later recommended)

Installation

Clone the repository:

git clone https://github.com/sharplogic/LightNap.git
cd LightNap

Backend Setup:
- Navigate to the src directory:
```
cd src
```
- Run the application:
```
dotnet run --project LightNap.WebApi
```
The application will log errors and quit if anything in the startup or seeding process fails. This includes database migrations and user/role seeding. Please check the logs if a deployment fails to start.
Frontend Setup:
- In a separate terminal, navigate to the lightnap-ng directory:
```
cd src/lightnap-ng
```
- Install Angular dependencies:
```
npm install
```
- Run the Angular application:
```
ng serve
```

Usage

Access the application at http://localhost:4200.
By default, three user accounts are created with different roles for testing:
- Administrator: Admin@lightnap.azurewebsites.net / P@ssw0rd
- Content Editor: ContentEditor@lightnap.azurewebsites.net / P@ssw0rd
- Regular User: RegularUser@lightnap.azurewebsites.net / P@ssw0rd
If you are debugging the backend in Visual Studio you may see an Exception User-Unhandled dialog whenever a UserFriendlyApiException is thrown. It is recommended that you disable this behavior by unchecking the Break when this exception type is user-unhandled since those exceptions are thrown regularly as part of normal operation.

Testing

LightNap includes comprehensive testing setup for both unit and end-to-end tests.

Running Unit Tests

To run Angular unit tests with Karma:

cd src/lightnap-ng
npm run test

For CI/headless execution:

npm run test:ci

Running E2E Tests

To run Cypress end-to-end tests:

npm run e2e:open        # Interactive mode with live backend
npm run e2e:mocks:open  # Interactive mode with mocked backend
npm run e2e             # Headless mode with live backend
npm run e2e:mocks       # Headless mode with mocked backend
npm run e2e:ci          # CI mode with recording (runs against a live backend by default)

Test Coverage

Generate and view coverage reports:

npm run test:coverage
npm run test:coverage:open

Dependency Management

Backend Updates

To update NuGet packages in the backend:

Navigate to the src directory:
```
cd src
```
List outdated packages:
```
dotnet list package --outdated
```
Update a specific package to the latest version:
```
dotnet add package <PackageName>
```
For each project in the solution, navigate to its directory and run the command, or specify the project:
```
dotnet add LightNap.Core/LightNap.Core.csproj package <PackageName>
```
After updating packages, restore and build to verify:
```
dotnet restore
dotnet build
```

Unlike npm, .NET doesn’t have a built-in command to update all packages at once. You’ll need to update each package individually using dotnet add package, or use Visual Studio’s NuGet Package Manager UI for a more convenient batch update experience.

Always review release notes and test thoroughly after updating NuGet packages, especially for major version updates. Consider updating in a separate branch and running the full test suite before merging.

Frontend Updates

The project includes several npm scripts to help manage frontend dependencies:

Checking for Updates

To check which dependencies have available updates (excluding Angular packages):

npm run update:check

This command uses npm-check-updates (ncu) to display available non-Angular updates without modifying any files.

Alternatively you can run the command via npx without installing globally or adding a dependency: npx ncu --reject "/@angular/".

Updating Non-Angular Dependencies

To update all non-Angular dependencies to their latest versions:

npm run update:deps

This command updates the package.json file, installs the new versions, and runs a build to verify compatibility.

Updating Angular

To update Angular and related packages:

npm run update:angular

This uses Angular’s built-in update mechanism (ng update) to safely update Angular packages and runs a build to verify the update.

Updating All Dependencies

To update both Angular and non-Angular dependencies:

npm run update:all

To update all dependencies and run tests:

npm run update:all:test

Always review the changes and test thoroughly after updating dependencies, especially for major version updates. Consider updating dependencies in a separate branch and running the full test suite before merging.