Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fiware/tutorials.ngsi-v2
:department_store: :handbag: NGSI-v2 Tutorials based around a Smart Supermarket
https://github.com/fiware/tutorials.ngsi-v2
access-control contextual-data fiware iot-agent ngsi-v2 security tutorial
Last synced: about 1 month ago
JSON representation
:department_store: :handbag: NGSI-v2 Tutorials based around a Smart Supermarket
- Host: GitHub
- URL: https://github.com/fiware/tutorials.ngsi-v2
- Owner: FIWARE
- License: mit
- Created: 2021-04-06T07:46:56.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T08:15:37.000Z (7 months ago)
- Last Synced: 2024-05-29T05:17:52.082Z (7 months ago)
- Topics: access-control, contextual-data, fiware, iot-agent, ngsi-v2, security, tutorial
- Language: JavaScript
- Homepage: http://fiware-tutorials.rtfd.io/
- Size: 2.06 MB
- Stars: 7
- Watchers: 11
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Smart Supermarket Tutorials[
]("https://fiware-ges.github.io/orion/api/v2/stable/)[
](https://www.fiware.org/)
[](https://fiware-tutorials.rtfd.io)
[](https://opensource.org/licenses/MIT)
[](https://stackoverflow.com/questions/tagged/fiware)
[](https://quay.io/repository/fiware/tutorials.context-provider)
[](https://fiware-tutorials.rtfd.io)
[](https://github.com/FIWARE/tutorials.NGSI-v2/actions?query=workflow%3ACI)
This is a collection of tutorials for the FIWARE ecosystem designed for **NGSI-v2** developers. Each tutorial consists
of a series of exercises to demonstrate the correct use of individual FIWARE components and shows the flow of context
data within a simple Smart Solution either by connecting to a series of dummy IoT devices or manipulating the context
directly or programmatically.
| :books: [NGSI-v2
Documentation](https://fiware-tutorials.rtfd.io) | 
[Postman
Collections](https://explore.postman.com/team/3mM5EY6ChBYp9D) | [](https://hub.docker.com/u/fiware)
[](https://quay.io/organization/fiware)
[](https://artifacthub.io/packages/search?repo=fiware) | 
[**developer​.fiware.org**](https://www.fiware.org/developers/) |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
🇯🇵 このチュートリアルは[日本語](https://fiware-tutorials.letsfiware.jp/)でもご覧いただけます。
> [!NOTE]
>
> **Should I use NGSI-v2 or NGSI-LD?**
>
> FIWARE offers two flavours of the NGSI interfaces:
>
>
> - **NGSI-v2** offers JSON based interoperability used in individual Smart Systems
> - **NGSI-LD** offers JSON-LD based interoperability used for Federations and Data Spaces
>
> NGSI-v2 is ideal for creating individual applications offering interoperable interfaces for web services
> or IoT devices. It is easier to understand than NGSI-LD and does not require a JSON-LD `@context`
>
> However, NGSI-LD and Linked Data is necessary when creating a data space or introducing a system of
> systems aproach, and in situations requiring interoperability across apps and organisations.
>
> More information about NGSI-LD can be found [here](https://ngsi-ld-tutorials.readthedocs.io)
Data models
The following NGSI-v2 and NGSI-LD Data models are used within the tutorials:
- 
Tutorial-specific Data Models
-
Smart Data Models
## Install
To download the full set of tutorials, simply clone this repository:
```console
git clone https://github.com/FIWARE/tutorials.NGSI-v2.git
cd tutorials.NGSI-v2/
git submodule update --init --recursive
```
### Docker and Docker Compose 
The NGSI-v2 tutorials are designed to run under any Unix environment, the tested configuration and
[GitPod](https://github.com/gitpod-io/gitpod) environment is currently based on Ubuntu 22.04.2 LTS. However, there may
be some minor issues when running the tutorials directly on Windows machines or Apple M1 Silicon `amd64` systems, and
the following [Virtual Box set-up](docs/virtual-box.md) or [WSL set-up](docs/wsl.md) can be used when facing issues.
Each tutorial runs all components using [Docker](https://www.docker.com). **Docker** is a container technology which
allows to different components isolated into their respective environments.
- To install Docker on Windows follow the instructions [here](https://docs.docker.com/docker-for-windows/)
- To install Docker on Mac follow the instructions [here](https://docs.docker.com/docker-for-mac/)
- To install Docker on Linux follow the instructions [here](https://docs.docker.com/install/)
**Docker Compose** is a tool for defining and running multi-container Docker applications. A series of `*.yaml` files
are used configure the required services for the application. This means all container services can be brought up in a
single command. Docker Compose is installed by default as part of Docker for Windows and Docker for Mac, however Linux
users will need to follow the instructions found [here](https://docs.docker.com/compose/install/)
You can check your current **Docker** and **Docker Compose** versions using the following commands:
```console
docker-compose -v
docker version
```
Please ensure that you are using Docker version 24.0.x or higher and Docker Compose 2.24.x or higher and upgrade if
necessary.
### Postman 
The tutorials which use HTTP requests supply a collection for use with the Postman utility. Postman is a testing
framework for REST APIs. The tool can be downloaded from [www.postman.com](https://www.postman.com/downloads/). All the
FIWARE Postman collections can be downloaded directly from the
[Postman API network](https://explore.postman.com/team/3mM5EY6ChBYp9D)
### GitPod 
[Gitpod](https://github.com/gitpod-io/gitpod) is an open-source Kubernetes application for ready-to-code cloud
development environments that spins up an automated dev environment for each task, in the cloud. It enables you to run
the tutorials in a cloud development environment directly from your browser or your Desktop IDE.
### Apache Maven 
[Apache Maven](https://maven.apache.org/download.cgi) is a software project management and comprehension tool. Based on
the concept of a project object model (POM), Maven can manage a project's build, reporting and documentation from a
central piece of information. Maven can be used to define and download our dependencies and to build and package Java or
Scala code into a JAR file.
### Windows Subsystem for Linux
We will start up our services using a simple bash script. Windows users should download the
[Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) to provide a command-line
functionality similar to a Linux distribution on Windows.
## Tutorials List []("https://fiware-ges.github.io/orion/api/v2/stable/)
### Core Context Management: NGSI-v2 Fundamentals
101. [Getting Started](https://github.com/FIWARE/tutorials.Getting-Started/tree/NGSI-v2)
102.
[Entity Relationships](https://github.com/FIWARE/tutorials.Entity-Relationships/tree/NGSI-v2)
103.
[CRUD Operations](https://github.com/FIWARE/tutorials.CRUD-Operations/tree/NGSI-v2)
104.
[Context Providers](https://github.com/FIWARE/tutorials.Context-Providers/tree/NGSI-v2)
105.
[Altering the Context Programmatically](https://github.com/FIWARE/tutorials.Accessing-Context/tree/NGSI-v2)
106. [Subscribing to Changes in Context](https://github.com/FIWARE/tutorials.Subscriptions/tree/NGSI-v2)
### Internet of Things, Robots and third-party systems
201. [Introduction to IoT Sensors](https://github.com/FIWARE/tutorials.IoT-Sensors/tree/NGSI-v2)
202.
[Provisioning an IoT Agent](https://github.com/FIWARE/tutorials.IoT-Agent/tree/NGSI-v2)
203.
[IoT over an MQTT Transport](https://github.com/FIWARE/tutorials.IoT-over-MQTT/tree/NGSI-v2)
204.
[Using an alternative IoT Agent](https://github.com/FIWARE/tutorials.IoT-Agent-JSON/tree/NGSI-v2)
205.
[Creating a Custom IoT Agent](https://github.com/FIWARE/tutorials.Custom-IoT-Agent/tree/NGSI-v2)
206.
[IoT over an IOTA Tangle Transport](https://github.com/FIWARE/tutorials.IoT-over-IOTA/tree/NGSI-v2)
### Core Context Management: Manipulating Context Data and Persisting Historic Data
301. [Persisting Context Data using Apache Flume](https://github.com/FIWARE/tutorials.Historic-Context-Flume) -
MongoDB, MySQL, PostgreSQL
302.
[Persisting Context Data using Apache NIFI](https://github.com/FIWARE/tutorials.Historic-Context-NIFI) - MongoDB, MySQL,
PostgreSQL
303.
[Querying Time Series Data (MongoDB)](https://github.com/FIWARE/tutorials.Short-Term-History/tree/NGSI-v2)
304.
[Querying Time Series Data (CrateDB)](https://github.com/FIWARE/tutorials.Time-Series-Data/tree/NGSI-v2)
305. [Big Data Analysis (Flink)](https://github.com/FIWARE/tutorials.Big-Data-Flink/tree/NGSI-v2)
306. [Big Data Analysis (Spark)](https://github.com/FIWARE/tutorials.Big-Data-Spark/tree/NGSI-v2)
### Security: Identity Management
401.
[Managing Users and Organizations](https://github.com/FIWARE/tutorials.Identity-Management/tree/NGSI-v2)
402. [Roles and Permissions](https://github.com/FIWARE/tutorials.Roles-Permissions/tree/NGSI-v2)
403.
[Securing Application Access](https://github.com/FIWARE/tutorials.Securing-Access/tree/NGSI-v2)
404.
[Securing Microservices with a PEP Proxy](https://github.com/FIWARE/tutorials.PEP-Proxy/tree/NGSI-v2)
405.
[XACML Rules-based Permissions](https://github.com/FIWARE/tutorials.XACML-Access-Rules/tree/NGSI-v2)
406.
[Administrating XACML via a PAP](https://github.com/FIWARE/tutorials.Administrating-XACML/tree/NGSI-v2)
407.
[Authenticating Identities (Open-ID Connect)](https://github.com/FIWARE/tutorials.Securing-Access-OpenID-Connect/tree/NGSI-v2)
### Processing, Analysis and Visualization
501. [Creating Application Mashups](https://github.com/FIWARE/tutorials.Application-Mashup/tree/NGSI-v2)
503. [Introduction to Media Streams](https://github.com/FIWARE/tutorials.Media-Streams/tree/NGSI-v2)
507. [Cloud-Edge Computing](https://github.com/FIWARE/tutorials.Edge-Computing/tree/NGSI-v2)
### NGSI-LD for NGSI-v2 Developers
601. [Introduction to Linked Data](https://github.com/FIWARE/tutorials.Linked-Data/tree/NGSI-v2)
602.
[Linked Data Relationships and Data Models](https://github.com/FIWARE/tutorials.Relationships-Linked-Data/tree/NGSI-v2)
603.
[Traversing Linked Data Programmatically](https://github.com/FIWARE/tutorials.Accessing-Linked-Data/tree/NGSI-v2)
604.
[Linked Data Subscriptions and Registrations](https://github.com/FIWARE/tutorials.LD-Subscriptions-Registrations/tree/NGSI-v2)
## Usage
Most tutorials supply a `services` script to start the containers:
```console
cd
./services start
```
### Following the tutorial exercises via Postman
Each tutorial submodule contains one or more `docker-compose.yml` files, along with a Postman collection containing the
necessary HTTP requests: import the collection into Postman and follow the instructions.
### Following the tutorial exercises from the command-line
Each submodule contains full instructions in README which details the appropriate bash commands (cUrl and Docker
Compose) to run.
Full instructions can be found within the [documentation](https://fiware-tutorials.rtfd.io)
---
## License
[MIT](LICENSE) © 2018-2024 FIWARE Foundation e.V.