IoT Tracking

Digital Matter Interview Assessment

Prerequisites

Before you begin, ensure you have installed the following:

• Visual Studio 2022 with the ASP.NET and web development workload
• .NET 8.0 SDK or later
• Node.js (LTS version recommended)
• Git

Entity Framework Core CLI

The Entity Framework Core CLI tools are required to apply the migrations to the database. You can install the tools by running the following command:

dotnet tool install --global dotnet-ef

Development Environment Setup

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Cloning the Repository

To get started, clone the repository to your local machine:

git clone https://github.com/darrenmlouw/IoTTracking.git

Opening the Solution in Visual Studio

Open the cloned repository in Visual Studio 2022 as Administrator. Double-click on the IoTTracking.sln solution file to open it.

Configure Startup Projects

• Right-click on the Solution in the Solution Explorer.
• Choose 'Set StartUp Projects...'
• Select 'Multiple startup projects'.
• Set action to 'Start' for both IoTTracking.Server and iottracking.client projects.

-Click OK.

Apply Migrations (CMDF or Package Manager Console) - Please look further down for package manager console instructions

Using the terminal, navigate to the IoTTracking.Infrastructure directory and apply the migrations.

Navigate back to the root directory (IoTTracking)

cd IoTTracking

Nagivate to the IoTTracking.Infrastructre directory

cd IoTTracking.Infrastructure

Apply the migrations

set ASPNETCORE_ENVIRONMENT=Development
dotnet ef database update --project ../IoTTracking.Infrastructure

Using package manager console in Visual Studio

• Open the package manager console in Visual Studio.
• Set the Default Project to IoTTracking.Infrastructure.
• Run the following command to apply the migrations:

  Update-Database -Args 'Development'
  

After this step, please ensure that a database named IoTTrackingDev has been created and the tables have been created and seeded with data.

If for some reason you cannot apply the migrations, you can run the SQL scripts provided below. After manually creating the database 'IoTTrackingDev', you can run the SQL scripts below to create the tables and seed the data.

Running the Application

• Press F5 to run the application. This will start the API server and the React frontend.

The API server should now be running on http://localhost:5154. and the React frontend should be running on https://localhost:5173. The Windows will not open automatically, you will need to open the browser and navigate to the URLs.

If the Frontend is not working, you can run the following command from iottracking.client to start the frontend server.

npm run dev

Swagger Documentation

There is proxy setup for the frontend to communicate with the backend API. The proxy is configured to use the API server running on http://localhost:5154 or https://localhost:7253. To access the swagger documentation, navigate to http://localhost:5154/swagger. or https://localhost:7253/swagger.

SQL Scripts

Create a Database named IoTTrackingDev and run the following SQL scripts to create the tables and seed the data.

IF OBJECT_ID(N'[__EFMigrationsHistory]') IS NULL
BEGIN
    CREATE TABLE [__EFMigrationsHistory] (
        [MigrationId] nvarchar(150) NOT NULL,
        [ProductVersion] nvarchar(32) NOT NULL,
        CONSTRAINT [PK___EFMigrationsHistory] PRIMARY KEY ([MigrationId])
    );
END;
GO

BEGIN TRANSACTION;
GO

CREATE TABLE [Firmwares] (
    [FirmwareId] int NOT NULL IDENTITY,
    [Version] VARCHAR(255) NOT NULL,
    CONSTRAINT [PK_Firmwares] PRIMARY KEY ([FirmwareId])
);
GO

CREATE TABLE [Groups] (
    [GroupId] int NOT NULL IDENTITY,
    [Name] VARCHAR(255) NOT NULL,
    [ParentGroupId] int NULL,
    CONSTRAINT [PK_Groups] PRIMARY KEY ([GroupId]),
    CONSTRAINT [FK_Groups_Groups_ParentGroupId] FOREIGN KEY ([ParentGroupId]) REFERENCES [Groups] ([GroupId]) ON DELETE NO ACTION
);
GO

CREATE TABLE [Devices] (
    [DeviceId] int NOT NULL IDENTITY,
    [Name] VARCHAR(255) NOT NULL,
    [FirmwareId] int NOT NULL,
    [GroupId] int NULL,
    CONSTRAINT [PK_Devices] PRIMARY KEY ([DeviceId]),
    CONSTRAINT [FK_Devices_Firmwares_FirmwareId] FOREIGN KEY ([FirmwareId]) REFERENCES [Firmwares] ([FirmwareId]) ON DELETE CASCADE,
    CONSTRAINT [FK_Devices_Groups_GroupId] FOREIGN KEY ([GroupId]) REFERENCES [Groups] ([GroupId]) ON DELETE NO ACTION
);
GO

IF EXISTS (SELECT * FROM [sys].[identity_columns] WHERE [name] IN (N'FirmwareId', N'Version') AND [object_id] = OBJECT_ID(N'[Firmwares]'))
    SET IDENTITY_INSERT [Firmwares] ON;
INSERT INTO [Firmwares] ([FirmwareId], [Version])
VALUES (1, 'v1.2.5'),
(2, 'v1.3.0'),
(3, 'v2.0.1');
IF EXISTS (SELECT * FROM [sys].[identity_columns] WHERE [name] IN (N'FirmwareId', N'Version') AND [object_id] = OBJECT_ID(N'[Firmwares]'))
    SET IDENTITY_INSERT [Firmwares] OFF;
GO

IF EXISTS (SELECT * FROM [sys].[identity_columns] WHERE [name] IN (N'GroupId', N'Name', N'ParentGroupId') AND [object_id] = OBJECT_ID(N'[Groups]'))
    SET IDENTITY_INSERT [Groups] ON;
INSERT INTO [Groups] ([GroupId], [Name], [ParentGroupId])
VALUES (1, 'North America', NULL),
(2, 'Europe', NULL),
(3, 'Asia', NULL),
(4, 'USA', 1),
(5, 'Canada', 1),
(6, 'Germany', 2),
(7, 'France', 2),
(8, 'China', 3),
(9, 'Japan', 3);
IF EXISTS (SELECT * FROM [sys].[identity_columns] WHERE [name] IN (N'GroupId', N'Name', N'ParentGroupId') AND [object_id] = OBJECT_ID(N'[Groups]'))
    SET IDENTITY_INSERT [Groups] OFF;
GO

IF EXISTS (SELECT * FROM [sys].[identity_columns] WHERE [name] IN (N'DeviceId', N'FirmwareId', N'GroupId', N'Name') AND [object_id] = OBJECT_ID(N'[Devices]'))
    SET IDENTITY_INSERT [Devices] ON;
INSERT INTO [Devices] ([DeviceId], [FirmwareId], [GroupId], [Name])
VALUES (1, 1, 4, 'Thermostat - Office 101'),
(2, 2, 4, 'Security Camera - Entrance'),
(3, 1, 5, 'Smart Light - Hallway'),
(4, 3, 6, 'HVAC System - HQ'),
(5, 2, 7, 'Door Lock - Warehouse'),
(6, 1, 8, 'Water Sensor - Basement'),
(7, 3, 9, 'Air Quality Monitor - Lab');
IF EXISTS (SELECT * FROM [sys].[identity_columns] WHERE [name] IN (N'DeviceId', N'FirmwareId', N'GroupId', N'Name') AND [object_id] = OBJECT_ID(N'[Devices]'))
    SET IDENTITY_INSERT [Devices] OFF;
GO

CREATE INDEX [IX_Devices_FirmwareId] ON [Devices] ([FirmwareId]);
GO

CREATE INDEX [IX_Devices_GroupId] ON [Devices] ([GroupId]);
GO

CREATE UNIQUE INDEX [IX_Firmwares_Version] ON [Firmwares] ([Version]);
GO

CREATE INDEX [IX_Groups_ParentGroupId] ON [Groups] ([ParentGroupId]);
GO

INSERT INTO [__EFMigrationsHistory] ([MigrationId], [ProductVersion])
VALUES (N'20240407124247_V1.0.0', N'8.0.3');
GO

COMMIT;
GO