docs: List InfluxDB credential prereqs

jstirnaman · jstirnaman · commit ebdd558e2545 · 2024-05-14T15:42:14.000-05:00
- Add prereqs. We overlooked creating buckets or intended to use the example app to create them. That's a nice-to-have.
diff --git a/README.md b/README.md
@@ -20,14 +20,21 @@ To learn how to create the app from scratch, follow the IoT Starter tutorial.
 To run the app, do the following:
 
 1. If you haven't already, [create an InfluxDB Cloud account](https://www.influxdata.com/products/influxdb-cloud/) or [install InfluxDB OSS](https://www.influxdata.com/products/influxdb/).
-2. Clone this repository to your machine.
-3. Change to the directory--for example, enter the following code into the terminal:
+2. Set up InfluxDB--the example app assumes you have the following:
+
+   - An InfluxDB [org ID](https://docs.influxdata.com/influxdb/v2/admin/organizations/view-orgs/)
+   - A [bucket](https://docs.influxdata.com/influxdb/v2/admin/buckets/create-bucket/#create-a-bucket-using-the-influxdb-api) named `iot_center` for storing measurement data collected from devices
+   - A [bucket](https://docs.influxdata.com/influxdb/v2/admin/buckets/create-bucket/#create-a-bucket-using-the-influxdb-api) named `iot_center_devices` for storing device metadata and API token IDs
+   - An [API token](https://docs.influxdata.com/influxdb/v2/admin/tokens/create-token/) (for example, an **All Access token**) that has read and write permissions for the buckets
+
+3. Clone this repository to your machine.
+4. Change to the directory--for example, enter the following code into the terminal:
 
    ```bash
    cd ./iot-api-python
    ```
 
-4. Set environment variables for `INFLUX_TOKEN` and `INFLUX_ORG`--for example, enter the following commands into your terminal:
+5. Set environment variables for `INFLUX_TOKEN` and `INFLUX_ORG`--for example, enter the following commands into your terminal:
 
    ```bash
    export INFLUX_TOKEN=<INFLUX_TOKEN>
@@ -39,7 +46,7 @@ To run the app, do the following:
    - **`<INFLUX_TOKEN>`**: your InfluxDB [API token](#authorization) with permission to query (_read_) buckets and create (_write_) authorizations for devices.
    - **`<INFLUX_ORG_ID>`**: your InfluxDB organization ID.
 
-5. If you need to adjust the defaults to match your InfluxDB instance, edit the settings in`./config.ini`:
+6. If you need to adjust the defaults to match your InfluxDB instance, edit the settings in`./config.ini`:
 
    ```ini
    [APP]
@@ -52,7 +59,7 @@ To run the app, do the following:
 
    - **`<INFLUX_URL>`**: your InfluxDB instance URL--for example, the default OSS URL `http://localhost:8086`.
 
-6. Create and activate a Python virtual environment for the project.
+7. Create and activate a Python virtual environment for the project.
    Enter the following commands into your terminal:
 
    ```bash
@@ -64,7 +71,7 @@ To run the app, do the following:
    source virtualenv/bin/activate
    ```
 
-7. Install `pdm` package manager for your system.
+8. Install `pdm` package manager for your system.
 On Linux or macOS, enter the following command into your terminal:
 
    ```bash
@@ -77,27 +84,27 @@ On Linux or macOS, enter the following command into your terminal:
    (Invoke-WebRequest -Uri https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py -UseBasicParsing).Content | python -
    ```
 
-8. Use `pdm` to install dependencies.
+1. Use `pdm` to install dependencies.
    Enter the following command into your terminal:
 
    ```bash
    pdm install
    ```
 
-9. If you use a bash terminal, you can set an environment variable to use dependencies in `pdm.lock` when you run your application scripts.
+2. If you use a bash terminal, you can set an environment variable to use dependencies in `pdm.lock` when you run your application scripts.
    Enter the following command into your bash terminal:
 
    ```bash
    eval "$(pdm --pep582)"
    ```
 
-10. To start the Flask application, enter the following command into your terminal:
+3.  To start the Flask application, enter the following command into your terminal:
 
     ```bash
     flask run -h localhost -p 3001
     ```
 
     To view the application, visit <http://localhost:3001> in your browser.
 
-11. Next, you can use the example [iot-api-ui](https://github.com/influxdata/iot-api-ui) React frontend to interact with the API.
+4.  Next, you can use the example [iot-api-ui](https://github.com/influxdata/iot-api-ui) React frontend to interact with the API.
 
