Welcome to the Streamsheet® core project

The Streamsheet® core is an open-source tool for making your data immediately understandable and for creating IoT applications visually and interactively - without a single line of code.

If you are new to Streamsheets, you should start with the introduction guide or with the following video:

Also, visit us on our website or check out the Streamsheets forum.

Table of contents

• Installation
• Quick start
• Documentation
• FAQ
• License

🔌 Installation

Using Docker and Docker Compose

There are Docker images available for installing Streamsheets on Linux, macOS, Windows and Raspberry Pi (tested with Raspbian). For each of those installations we provide a separate installer image, that facilitates the installation process.

Run the following command to execute the installer for Streamsheets (replace the placeholders accordingly).

• <PATH>: path to the installation directory, e.g., "~/streamsheets"
• <VERSION>: version to install, e.g., "2.0"
• <PLATFORM>: target platform (one of linux, macos, rpi, win)

docker run -v <PATH>:/streamsheets cedalo/streamsheets-installer:<VERSION>-<PLATFORM>

Example

docker run -v ~/streamsheets:/streamsheets cedalo/streamsheets-installer:2.0-linux

🚀 Quick start

After successfully running the installer navigate to the install directory and run the start script (depending on the target platform).

For Linux:

cd <PATH>
sh start.sh

For macOS:

cd <PATH>
sh start.sh

For Windows:

cd <PATH>
start.bat

For Raspberry Pi:

cd <PATH>
sh start.sh

📚 Documentation

You can find the Streamsheet documentation on the documentation website.

Check out the Getting Started page for a quick overview.

The documentation is divided into several sections:

• Installation
• Introduction
• Main Components
• Getting Started
• Tutorials
• Functions
• Other
• Glossary

🙋 FAQ

Who maintains Streamsheets?

Streamsheets are maintained by the Cedalo AG. Please check out our team page!

Looking for support?

For questions and support please join our Forum, ask a question on Stack Overflow, or contact us on Twitter.

Where are the docs?

Check out our documentation website: docs.cedalo.com.

Want to contribute to Streamsheets?

Check out our CONTRIBUTING.md to get started.

• Check out the issues with the good first issue and help wanted label.
• Also have a look at our roadmap.

How is the repository structured?

The Streamsheets repository is organized as a mono repository that is composed of many npm packages.

⭐️ Show your support

Give a ⭐️ if this project helped you!

📃 License

Copyright (c) 2017-2019 Cedalo AG.

Streamsheets is licensed under the Eclipse Public License - v 2.0. Please see the LICENSE file for details.