Getting Started

Creating an Nstream application with Nstream-Jet is straightforward. Follow these steps to get started:

  1. Create a configuration file:
    • Begin by creating a JSON configuration file specifying the connection details for your data sources.
    • Refer to the Configuration File section for guidance on the structure and required fields.
  2. Generate an Nstream Application:
    • Open your terminal or command prompt.
    • Navigate to the directory containing your JSON configuration file.
    • Run the following command to generate an Nstream application:
       nstream-jet -f <configuration.json>
    • Replace <configuration.json> with the name of your JSON configuration file.
  3. Explore Your Nstream Application:
    • Once the generation process is complete, you will find the generated Nstream resources in the directory.
    • Use docker compose up to start the server using local Docker.
    • Explore the UI at http://localhost:9001.
    • The URL may change depending on configuration and where you deploy the application. More generally the URL is http(s)://<hostname>:<port>.

Congratulations! You have successfully generated an Nstream application using Nstream-Jet. You can now start building real-time streaming applications with ease using the generated APIs.

Command Line Options

Nstream-Jet provides the following command line options:

Nstream is licensed under the Redis Source Available License 2.0 (RSALv2).