{"id":20777771,"url":"https://github.com/fiware/tutorials.ngsi-ld","last_synced_at":"2025-08-22T02:08:14.205Z","repository":{"id":37435333,"uuid":"268751053","full_name":"FIWARE/tutorials.NGSI-LD","owner":"FIWARE","description":":tractor: :cow: NGSI-LD Tutorials based around a Smart Farm ","archived":false,"fork":false,"pushed_at":"2025-08-13T08:34:42.000Z","size":3807,"stargazers_count":31,"open_issues_count":2,"forks_count":25,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-08-13T10:24:23.772Z","etag":null,"topics":["contextual-data","fiware","ngsi-ld","tutorial"],"latest_commit_sha":null,"homepage":"http://ngsi-ld-tutorials.rtfd.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FIWARE.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-06-02T08:57:05.000Z","updated_at":"2025-08-13T08:34:46.000Z","dependencies_parsed_at":"2023-02-14T15:16:24.263Z","dependency_job_id":"c868c447-f812-47f6-a594-3fbb080fe9ae","html_url":"https://github.com/FIWARE/tutorials.NGSI-LD","commit_stats":{"total_commits":573,"total_committers":15,"mean_commits":38.2,"dds":0.3403141361256544,"last_synced_commit":"4a5c50513b380d8821750ae31be5bb28055ccd57"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/FIWARE/tutorials.NGSI-LD","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Ftutorials.NGSI-LD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Ftutorials.NGSI-LD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Ftutorials.NGSI-LD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Ftutorials.NGSI-LD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FIWARE","download_url":"https://codeload.github.com/FIWARE/tutorials.NGSI-LD/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE%2Ftutorials.NGSI-LD/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271574431,"owners_count":24783319,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["contextual-data","fiware","ngsi-ld","tutorial"],"created_at":"2024-11-17T13:17:07.061Z","updated_at":"2025-08-22T02:08:14.193Z","avatar_url":"https://github.com/FIWARE.png","language":"JavaScript","readme":"# Smart Farm Tutorials[\u003cimg src=\"https://img.shields.io/badge/NGSI-LD-d6604d.svg\" width=\"90\"  align=\"left\" /\u003e](https://cim.etsi.org/NGSI-LD/official/0--1.html) [\u003cimg src=\"docs/img/logo.png\" align=\"left\" width=\"162\"\u003e](https://www.fiware.org/) \u003cbr/\u003e\n\n[![Documentation](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/documentation.svg)](https://ngsi-ld-tutorials.rtfd.io)\n[![License: MIT](https://img.shields.io/github/license/fiware/tutorials.Step-by-Step.svg)](https://opensource.org/licenses/MIT)\n[![Support badge](https://img.shields.io/badge/tag-fiware-orange.svg?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/fiware)\n[![Docker badge](https://img.shields.io/badge/quay.io-fiware%2Ftutorials.ngsi--ld-grey?logo=red%20hat\u0026labelColor=EE0000)](https://quay.io/repository/fiware/tutorials.ngsi-ld)\n\u003cbr\u003e [![Documentation](https://img.shields.io/readthedocs/ngsi-ld-tutorials.svg)](https://ngsi-ld-tutorials.rtfd.io)\n[![CI](https://github.com/FIWARE/tutorials.NGSI-LD/workflows/CI/badge.svg)](https://github.com/FIWARE/tutorials.NGSI-LD/actions?query=workflow%3ACI)\n\nThis is a collection of tutorials for the FIWARE ecosystem designed for **NGSI-LD** developers. Each tutorial consists\nof a series of exercises to demonstrate the correct use of individual FIWARE components and shows the flow of context\ndata within a simple Smart Solution either by connecting to a series of dummy IoT devices or manipulating the context\ndirectly or programmatically.\n\n| :books: \u003cbr\u003e[NGSI-LD\u003cbr\u003eDocumentation](https://ngsi-ld-tutorials.rtfd.io/) | \u003cimg src=\"https://assets.getpostman.com/common-share/postman-logo-stacked.svg\" align=\"center\" height=\"25\"\u003e \u003cbr/\u003e[Postman\u003cbr\u003eCollections](https://explore.postman.com/team/3mM5EY6ChBYp9D) | [![Docker Hub](https://nexus.lab.fiware.org/repository/raw/public/badges/docker/fiware.svg)](https://hub.docker.com/u/fiware) \u003cbr\u003e [![Quay.io](https://img.shields.io/badge/quay.io-fiware-grey?logo=red%20hat\u0026labelColor=EE0000)](https://quay.io/organization/fiware) \u003cbr\u003e [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/fiware)](https://artifacthub.io/packages/search?repo=fiware) | \u003cimg src=\"https://fiware.github.io/catalogue/img/fiware-emoji.png\" height=\"30px\" width=\"30px\"/\u003e \u003cbr/\u003e [**developer.\u0026ZeroWidthSpace;fiware.org**](https://www.fiware.org/developers/) |\n| -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n\n\u003cbr/\u003e\n\n\u003e [!NOTE]\n\u003e\n\u003e **Should I use NGSI-LD or NGSI-v2?**\n\u003e\n\u003e FIWARE offers two flavours of the NGSI interfaces:\n\u003e\n\u003e -   **NGSI-v2** offers JSON based interoperability used in individual Smart Systems\n\u003e -   **NGSI-LD** offers JSON-LD based interoperability used for Federations and Data Spaces\n\u003e\n\u003e Of the two, NGSI-LD is more complex and relies on the introduction of a JSON-LD `@context`. A full understanding of\n\u003e JSON-LD (Linked Data) is required to obtain the benefits of NGSI-LD , which allows for interoperability across apps\n\u003e and organisations.\n\u003e\n\u003e In general, you should use NGSI-LD when creating a data space or introducing a system of systems aproach.\n\u003e\n\u003e Use NGSI-v2 for simpler isolated systems. More information about NGSI-v2 can be found\n\u003e [here](https://fiware-tutorials.readthedocs.io)\n\n\u003ch3\u003eData models\u003c/h3\u003e\n\nThe tutorials define a series of data-models to be used within the `@context`. More information about the classes and\nattributes used can be found in the following:\n\n-   \u003cimg src=\"https://json-ld.org/favicon.ico\" align=\"center\" height=\"25\" alt=\"NGSI-LD\"/\u003e\n    \u003ca href=\"https://ngsi-ld-tutorials.readthedocs.io/en/latest/datamodels.html\"\u003eTutorial-specific Data Models\u003c/a\u003e.\n-   \u003cimg src=\"https://json-ld.org/favicon.ico\" align=\"center\" height=\"25\" alt=\"NGSI-LD\"/\u003e\n    \u003ca href=\"https://smartdatamodels.org\"\u003eSmart Data Models\u003c/a\u003e.\n\n## Install\n\nTo download the full set of tutorials, simply clone this repository:\n\n```console\ngit clone https://github.com/FIWARE/tutorials.NGSI-LD.git\ncd tutorials.NGSI-LD/\ngit submodule update --init --recursive\n```\n\n### Swagger \u003cimg src=\"https://static1.smartbear.co/swagger/media/assets/swagger_fav.png\" align=\"left\"  height=\"30\" width=\"30\" style=\"border-right-style:solid; border-right-width:10px; border-color:transparent; background: transparent\"\u003e\n\nThe OpenAPI Specification (commonly known as Swagger) is an API description format for REST APIs. A Swagger spec allows\nyou to describe an entire API (such as NGSI-LD itself) however in this tutorial we shall be concentrating on using\nSwagger to define data models.\n\nAPI specifications can be written in YAML or JSON. The format is easy to learn and readable to both humans and machines.\nThe complete OpenAPI Specification can be found on GitHub:\n[OpenAPI 3.0 Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md). This is\nimportant since we will need a well-defined structure to be able to generate `@context` files.\n\n### Docker and Docker Compose \u003cimg src=\"https://www.docker.com/favicon.ico\" align=\"left\"  height=\"36\" width=\"36\"\u003e\n\nThe NGSI-LD tutorials are designed to run under any Unix environment, the tested configuration and GitPod environment is\ncurrently based on Ubuntu 22.04.2 LTS. However, there may be some minor issues when running the tutorials directly on\nWindows machines or Apple M1 Silicon amd64 systems, and the following [Virtual Box set-up](docs/virtual-box.md) or\n[WSL set-up](docs/wsl.md) can be used when facing issues.\n\nEach tutorial runs all components using [Docker](https://www.docker.com). **Docker** is a container technology which\nallows to different components isolated into their respective environments.\n\n-   To install Docker on Windows follow the instructions [here](https://docs.docker.com/docker-for-windows/).\n-   To install Docker on Mac follow the instructions [here](https://docs.docker.com/docker-for-mac/).\n-   To install Docker on Linux follow the instructions [here](https://docs.docker.com/install/).\n\n**Docker Compose** is a tool for defining and running multi-container Docker applications. A series of `*.yaml` files\nare used configure the required services for the application. This means all container services can be brought up in a\nsingle command. Docker Compose is installed by default as part of Docker for Windows and Docker for Mac, however Linux\nusers will need to follow the instructions found [here](https://docs.docker.com/compose/install/).\n\nYou can check your current **Docker** and **Docker Compose** versions using the following commands:\n\n```console\ndocker-compose -v\ndocker version\n```\n\nPlease ensure that you are using Docker version 24.0.x or higher and Docker Compose 2.24.x or higher and upgrade if\nnecessary.\n\nAlthough not officially supported, older versions of docker without an integrated docker-compose can be run by adding\n`legacy` to all bash script commands:\n\n```console\n./services start legacy\n```\n\n### Postman \u003cimg src=\"docs/img/postman.png\" align=\"left\"  height=\"32\" width=\"32\"\u003e\n\nThe tutorials which use HTTP requests supply a collection for use with the Postman utility. Postman is a testing\nframework for REST APIs. The tool can be downloaded from [www.postman.com](https://www.postman.com/downloads/). All the\nFIWARE Postman collections can be downloaded directly from the\n[Postman API network](https://explore.postman.com/team/3mM5EY6ChBYp9D).\n\n### GitPod \u003cimg src=\"https://gitpod.io/favicon.ico\" align=\"left\"  height=\"30\" width=\"30\"\u003e\n\n[Gitpod](https://github.com/gitpod-io/gitpod) is an open-source Kubernetes application for ready-to-code cloud\ndevelopment environments that spins up an automated dev environment for each task, in the cloud. It enables you to run\nthe tutorials in a cloud development environment directly from your browser or your Desktop IDE.\n\n### Windows Subsystem for Linux\n\nWe will start up our services using a simple bash script. Windows users should download the\n[Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) to provide a command-line\nfunctionality similar to a Linux distribution on Windows.\n\n## Tutorials List[\u003cimg src=\"https://img.shields.io/badge/NGSI-LD-d6604d.svg\" width=\"90\"  align=\"left\" /\u003e](https://cim.etsi.org/NGSI-LD/official/0--1.html)\n\n### Core Context Management: NGSI-LD Fundamentals\n\n\u0026nbsp; 101. [Understanding `@context`](https://github.com/FIWARE/tutorials.Understanding-At-Context) \u003cbr/\u003e \n\u0026nbsp; 102. [Working with `@context`](https://github.com/FIWARE/tutorials.Getting-Started/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 103. [CRUD Operations](https://github.com/FIWARE/tutorials.CRUD-Operations/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 104. [Concise Payloads](https://github.com/FIWARE/tutorials.Concise-Format/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 105. [Merge-Patch and Put](https://github.com/FIWARE/tutorials.Merge-Patch-Put/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 106. [Entity Relationships](https://github.com/FIWARE/tutorials.Entity-Relationships/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 107. [Subscriptions](https://github.com/FIWARE/tutorials.Subscriptions/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 108. [Registrations](https://github.com/FIWARE/tutorials.Context-Providers/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 109. [Temporal Operations](https://github.com/FIWARE/tutorials.Short-Term-History/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 110. [Extended Properties](https://github.com/FIWARE/tutorials.Extended-Properties/tree/NGSI-LD) \u003cbr/\u003e\n\n### Internet of Things, Robots and third-party systems\n\n\u0026nbsp; 201. [Introduction to IoT Sensors](https://github.com/FIWARE/tutorials.IoT-Sensors/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 202. [Provisioning the Ultralight IoT Agent](https://github.com/FIWARE/tutorials.IoT-Agent/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 203. [Provisioning the JSON IoT Agent](https://github.com/FIWARE/tutorials.IoT-Agent-JSON/tree/NGSI-LD) \u003cbr/\u003e\n\n### Core Context Management: Manipulating Context Data and Persisting Historic Data\n\n\u0026nbsp; 304. [Querying Time Series Data (QuantumLeap)](https://github.com/FIWARE/tutorials.Time-Series-Data/tree/NGSI-LD)\n\u003cbr/\u003e \u0026nbsp; 305. [Big Data Analysis (Flink)](https://github.com/FIWARE/tutorials.Big-Data-Flink/tree/NGSI-LD) \u003cbr/\u003e\n\u0026nbsp; 306. [Big Data Analysis (Spark)](https://github.com/FIWARE/tutorials.Big-Data-Spark/tree/NGSI-LD)\n\n### Security: Identity Management\n\n\u0026nbsp; 401. [Managing Users and Organizations](https://github.com/FIWARE/tutorials.Identity-Management/tree/NGSI-LD)\n\u003cbr/\u003e \u0026nbsp; 402. [Roles and Permissions](https://github.com/FIWARE/tutorials.Roles-Permissions/tree/NGSI-LD)\n\n### Processing, Analysis and Visualization\n\n\u0026nbsp; 507. [Cloud-Edge Computing](https://github.com/FIWARE/tutorials.Edge-Computing/tree/NGSI-LD)\n\n### Integrating NGSI-v2 Systems:\n\n\u0026nbsp; 601.  [Federative Data Spaces](https://github.com/FIWARE/tutorials.Linked-Data/tree/NGSI-LD)\n\n## Usage\n\nMost tutorials supply a `services` script to start the containers:\n\n```console\ncd \u003ctutorial-name\u003e\ngit checkout NGSI-LD\n./services start\n```\n\n### Following the tutorial exercises via Postman\n\nEach tutorial submodule contains one or more `docker-compose.yml` files, along with a Postman collection containing the\nnecessary HTTP requests: import the collection into Postman and follow the instructions.\n\n### Following the tutorial exercises from the command-line\n\nEach submodule contains full instructions in README which details the appropriate bash commands (cUrl and Docker\nCompose) to run.\n\nFull instructions can be found within the [documentation](https://ngsi-ld-tutorials.rtfd.io/)\n\n---\n\n## License\n\n[MIT](LICENSE) © 2020-2025 FIWARE Foundation e.V.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiware%2Ftutorials.ngsi-ld","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffiware%2Ftutorials.ngsi-ld","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiware%2Ftutorials.ngsi-ld/lists"}