diff --git a/SETUP.md b/SETUP.md new file mode 100644 index 0000000..7a6414d --- /dev/null +++ b/SETUP.md @@ -0,0 +1,39 @@ +# Setup for Running the project Locally with Docker + +This document outlines the steps to configure and run an the project using Docker in your local environment. + +## Prerequisites + +Make sure you have the following instaled on your system. + +- Docker Engine: [Installation Instructions](https://docs.docker.com/engine/install/ubuntu/) +- Docker Compose: [Installation Instructions](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04) + +## Configuration Steps + +### 1. Clone the repository + +```bash +git clone https://github.com/your_username/your_project.git +``` + +### 2. Navigate to the Project Directory + + +```bash +cd your_project +``` + +### 3. Build and Run the Containers + + ```bash + docker-compose up --build +``` + +This will build the necessary images and run the containers according to the configuration in `docker-compose.yml`. + +### 4. Access Your Application + +Open a web browser and visit `http://localhost:3000` (or the port you specified) to access your application. + +--- \ No newline at end of file diff --git a/docs/How-to guides/How to configure and trigger a remote action in devices.md b/docs/How-to guides/How to configure and trigger a remote action in devices.md index c1eab09..95073f6 100644 --- a/docs/How-to guides/How to configure and trigger a remote action in devices.md +++ b/docs/How-to guides/How to configure and trigger a remote action in devices.md @@ -22,7 +22,7 @@ Biotz shows the same interface for both message types (specific to communication ## Step 2 - Setup device to get the order to perform the action. -Find specific MQTT broker information following this link. +Find specific MQTT broker information following this link. The specific device of the selected device type should be already registered under the 'Device Management' section for devices. The device should be configured to SUBSCRIBE to the specific topic that Biotz will use to notify the action to the device. The topic follows this pattern: diff --git a/docs/How-to guides/How to create a schema.md b/docs/How-to guides/How to create a schema.md index 65400ef..e90b0fb 100644 --- a/docs/How-to guides/How to create a schema.md +++ b/docs/How-to guides/How to create a schema.md @@ -34,7 +34,7 @@ After naming the schema the proper and important specification happens under the ![Item types](img/item-types.png) -Detailed specification of the item types is shared in here. +Detailed specification of the item types is shared in here. ‍ - Collection of identical items: collection of more than one identical item. Being an item anything from an object/map/dictionary to singular element as a text, boolean, integer or decimal. - Collection of unrelated items: collection of any kind of item, present just once. diff --git a/docs/How-to guides/How to create developer API credentials.md b/docs/How-to guides/How to create developer API credentials.md index 01c99d4..6759c5b 100644 --- a/docs/How-to guides/How to create developer API credentials.md +++ b/docs/How-to guides/How to create developer API credentials.md @@ -36,7 +36,7 @@ Now that we have our credentials created. We need to configure the authenticatio ![Developer](img/biotz-developer-api.png) Clicking the **Authorize** button a pop-up will show, in which we need to add this information, also found on the -Developer API Reference. +Developer API Reference. - **Username:** The username in the credentials file we have downloaded before. - **Password:** The password in the credentials file we have downloaded before. diff --git a/docs/How-to guides/How to publish device data.md b/docs/How-to guides/How to publish device data.md index 523a858..8e40622 100644 --- a/docs/How-to guides/How to publish device data.md +++ b/docs/How-to guides/How to publish device data.md @@ -6,11 +6,11 @@ sidebar_label: How to publish device data using MQTT - setup devices to send dat ## Introduction There is a standard format of the MQTT topics for sending data from devices to the Biotz IoT Platform. For this to happen there are these pre-steps that must be fulfilled: -- Organisation must be registered in Biotz. -- Device-Type, message-type and the schema of data schema of data to be sent must be registered in Biotz. -- Specific device must be registered. +- Organisation must be registered in Biotz. +- Device-Type, message-type and the schema of data schema of data to be sent must be registered in Biotz. +- Specific device must be registered. -Find specific MQTT broker information following this link. +Find specific MQTT broker information following this link. This is the generic MQTT topic builds: diff --git a/docs/Reference guides/Developer API.md b/docs/Reference guides/Developer API.md index ccf1ff3..b3d5567 100644 --- a/docs/Reference guides/Developer API.md +++ b/docs/Reference guides/Developer API.md @@ -2,12 +2,12 @@ sidebar_position: 4 --- -# Developer API +# Developer API Here you can see the different data related to the developer API. # Reference data -The API documentation with every available endpoint is here. If you want to know how to authorize correctly before consuming the API go here. +The API documentation with every available endpoint is here. If you want to know how to authorize correctly before consuming the API go here. In order to connect correctly you'll need this data: diff --git a/docs/Reference guides/MQTT broker.md b/docs/Reference guides/MQTT broker.md index 4a6541f..aa23d76 100644 --- a/docs/Reference guides/MQTT broker.md +++ b/docs/Reference guides/MQTT broker.md @@ -16,7 +16,7 @@ The authentication values are generated and provided when a new device is regist - **Username**: generated and provided when a device is registered. - **Password**: generated and provided when a device is registered. -More information about device registration here. +More information about device registration here. ## Topics @@ -27,7 +27,7 @@ More information about device registration More information +More information ### Subscribe @@ -36,12 +36,12 @@ biotz/1/0/CUSTOMER-ID/DEVICE-ID/publish/data/MESSAGE-TYPE-INTERNAL-NAME ``` biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/action/ACTION-MESSAGE-TYPE-INTERNAL-NAME ``` -More information +More information ### Firmware updates: ``` biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/firmware/update ``` -More information +More information diff --git a/docs/Tutorials/Getting started/index.md b/docs/Tutorials/Getting started/index.md index f3e70f6..dbaa442 100644 --- a/docs/Tutorials/Getting started/index.md +++ b/docs/Tutorials/Getting started/index.md @@ -28,5 +28,5 @@ In this tutorial, you will be generating various resources within Biotz. As you - **Message Type Schema**: Every message adheres to a specific structure. In Biotz, this structure is termed a Schema. A Schema outlines the format of data for a given Message Type.‍ - **Device**: This refers to the tangible apparatus that dispatches data to the platform. -With these concepts clarified, your initial task will involve the creation of a Device Type. +With these concepts clarified, your initial task will involve the creation of a Device Type.