ArlaNatureConnect Directory Reference

Directory dependency graph for ArlaNatureConnect:

Detailed Description

![Logo][Logo] Arla Nature Connect

Welcome to the Arla Nature Connect project! This repository contains resources and information for a prototype application designed for communication and collaboration on sustainability initiatives within the Arla Nature Connect community.

📚 Table of Contents

• Overview
• For developers
  • Getting Started
  • Project Structure
  • Debugging
• Wiki Documentation
• Boilerplate
  • ViewModelBase
  • ListViewModelBase
  • CRUDViewModelBase
• Services Used
  • AppMessageService
  • ConnectionStringService
  • StatusInfoService
• Documentation
• Use Cases

📖 Overview

Arla Nature Connect is a platform that enables members of the Arla Nature Connect community to connect, share ideas, and collaborate on sustainability projects. The application provides features such as discussion forums, resource sharing, event management, and project tracking to support the community's efforts in promoting sustainable practices.

👩‍💻 For developers

Guided instructions and information for developers interested in contributing to the Arla Nature Connect project.

🚀 Getting Started

To get started with the Arla Nature Connect project, follow these steps:

1. Clone the repository:

   git clone https://github.com/DMOoF25-TEAM11/ArlaNatureConnect.git
   cd ArlaNatureConnect

2. Install the required dependencies:

   dotnet restore

3. Build the solution:

   dotnet build

4. Database setup (required before running the application)

   The database schema and sample data must be created before launching the application. Execute the following scripts located in docs/sql/ using SQL Server Management Studio (SSMS) or a command-line tool such as sqlcmd.

   • docs/sql/DDL.sql – creates the database schema ArlaNatureConnect_Dev
   • docs/sql/DML.sql – inserts sample data used by the application

   SSMS (GUI):

   • Open SSMS and connect to your SQL Server instance.
   • Open E:\repos\ArlaNatureConnect\docs\sql\DDL.sql and execute it.
   • Open E:\repos\ArlaNatureConnect\docs\sql\DML.sql and execute it.

   sqlcmd (example):

   # Replace <server> with your SQL Server instance (e.g. . or (localdb)\MSSQLLocalDB)
   sqlcmd -S <server> -E -i "docs/sql/DDL.sql"
   sqlcmd -S <server> -E -i "docs/sql/DML.sql"

   Note: The DDL script creates a database named ArlaNatureConnect_Dev. Ensure the account used to run the scripts has permissions to create databases.

5. Run the application:

   dotnet run --project src/ArlaNatureConnect.WinUI/ArlaNatureConnect.WinUI (Package).wapproj

🗂️ Project Structure

Arla Nature Connect/
├── 📂 src/                                      # Source code for the project
│   ├── 📦 ArlaNatureConnect.Domain/             # Domain models
│   ├── 📦 ArlaNatureConnect.Core/               # Business logic
│   ├── 📦 ArlaNatureConnect.Infrastructure/     # Data access and external services
│   └── 📦 ArlaNatureConnect.WinUI/              # Windows application
├── 📂 tests/                                    # Unit and integration tests
│   └── 📦 ArlaNatureConnect/                    # Test projects
│       ├── 📦 TestCore/                         # Tests for core functionality
│       ├── 📦 TestDomain/                       # Tests for domain models
│       ├── 📦 TestInfrastructure/               # Tests for infrastructure
│       └── 📦 TestWinUI/                        # Tests for WinUI
├── 🖼️ images/                                   # Image assets for the project
├── 📄 docs/                                     # Documentation files
├── 📄 README.md                                 # Project documentation
└── 📄 .gitignore                                # Git ignore file

🐞 Debugging

When running the application in debug mode, the application will send debug meassages starting wih *** Namespace.Method : Message

Wiki Documentation

In-depth documentation for various components of the Arla Nature Connect project can be found in the docs/wiki directory.

📘 Boilerplate

Common base classes and patterns used throughout the application.
Click the links below for detailed documentation.

Abstract Classes	Description
ViewModelBase Documentation	Base class for all ViewModels in the application.
ListViewModelBase Documentation	Base class for ViewModels that represent a list of items.
CRUDViewModelBase Documentation	Base class for ViewModels that implement CRUD operations.

⚙️ Services Used

How to use common services in the application.
Click the links below for detailed documentation.

Services	Description
AppMessageService Documentation	Service for displaying application messages to the user.
ConnectionStringService Documentation	Service for managing database connection strings.
StatusInfoService Documentation	Service for displaying status information in the application.

Documentation

Additional documentation and resources for the Arla Nature Connect project can be found in the subfolder docs

• API reference (Doxygen): Doxygen
  (Open this file in a browser after Doxygen has been generated)

Use Cases

Use Case	Documentation
UC-001	Domain model DCD User Story SSD OC SD UCBrief UCCasual
UC-002	Artifacts

| UC-002B | | UC-003 | | UC-004 | Artifacts | | UC-010 |