Quick Start

This Quick Start Guide helps you set up the SME Adapter and create your first product in just a few steps either locally or using Docker.

Installation

1. Requirements

Before you start, make sure you have:

• .NET 8 SDK or later
  Download from https://dotnet.microsoft.com/download
• SQL Server Express (for local development)
• Git – to clone the repository
• (Optional) Docker Desktop – if you want to run the adapter inside a container

---

2. Local Installation (Executable Build)

Step 1: Clone the Repository

git clone https://github.com/Ra-one77/SME_Adapter.git
cd SME_Adapter

Step 2: Build the Application

You can build the solution in Visual Studio or via command line:

dotnet build SME_Adapter_Clean_Architecture.sln

Step 3: Update the Database

Run the following command in the Package Manager Console (or terminal):

Update-Database

This will create all required tables (e.g., Products, Companies, Documents).

Step 4: Run the Application

From the root directory, start the Blazor server:

dotnet run --project .\BlazorApp\

Then open your browser at https://localhost:7075

You’ll see the welcome screen to set up your Company Details.

---

3. Run with Docker

If you prefer to use Docker, follow these steps:

Step 1: Build the Docker Image

docker build -t sme-adapter .

Step 2: Run the Container

docker run -d -p 7075:7075 sme-adapter

Step 3: Access the Web Interface

Open your browser and go to http://localhost:7075

---

First Setup (After Launch)

After successful launch:

1. Open the Company Details page and fill in your organisation info.
2. Add your first Product and save it.
3. Check the Product List to confirm your data was stored.

See Company Details and Product Info for detailed field descriptions.

---

2. First Setup – Company Details

When you open the SME Adapter for the first time, you will see the Company Details form.

Fill in the required fields:

• Manufacturer Name
• Zip Code
• City
• Country
• (Optional) Upload Company Logo

Click Save and then Next to continue.

3. Add Your First Product

After saving company details, you will be asked to enter your first product.

Fill in:

• Product Designation
• Serial Number
• Product Root, Family, and Type
• Order Code / Article Number
• (Optional) Upload Product Image

Click Save. A confirmation will appear.

4. View Products

Navigate to the Products section in the sidebar to see all stored products.

Here you can:

• Verify that your product was stored
• Edit or delete entries
• Add more products
• View product-related documents

5. Next Steps

🎉 Congratulations – you have successfully set up your company and created your first product!

From here, you can:

• Add more products to your list
• Explore the Troubleshooting section if issues arise
• Integrate the stored data into Asset Administration Shell (AAS) submodels