https://github.com/mattercoder/matterflow-docs
matterflow-docs
https://github.com/mattercoder/matterflow-docs
Last synced: 12 months ago
JSON representation
matterflow-docs
- Host: GitHub
- URL: https://github.com/mattercoder/matterflow-docs
- Owner: MatterCoder
- Created: 2024-11-16T12:50:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-06T21:19:08.000Z (over 1 year ago)
- Last Synced: 2025-01-29T11:15:21.889Z (about 1 year ago)
- Language: JavaScript
- Size: 1.13 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Matterflow
Send Matter Data to the Cloud and AI applications
# Matterflow Documentation
Welcome to the **Matterflow Documentation Repository**! This project supports the **Matterflow Project**, which streamlines the processing, transformation, and streaming of data from **Matter-enabled IoT devices**. The Matterflow project also supports a standalone Docker based deployment for non Homeassistant use-cases. With Matterflow, you can unlock the full potential of your smart home setup, integrating seamlessly with cloud and AI applications. This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. We host this website on Netlify at this URL [Matterflow.cloud](https://www.matterflow.cloud/).
## Key Features
- **Automatic IoT Data Pipelines**: Receive, process, and store IoT data in formats like JSON and CSV.
- **Data Transformation**: Customize rules for data modeling and export.
- **AI-Ready Integration**: Seamlessly share data with machine learning applications.
To view the **Matterflow** project page, visit the [main github repo](https://github.com/MatterCoder/matterflow).
For detailed setup and tutorials, visit the [Getting Started documentation](https://matterflow.cloud/docs/intro).
---
## Contribute to the Documentation
Your contributions make Matterflow better! Here’s how you can help:
- **Enhance Existing Content**: Clarify, expand, or improve current documentation.
- **Report Issues**: Found gaps or errors? Let us know!
- **Submit Pull Requests**: Add examples, correct typos, or share your expertise with others.
Check out our [contribution guide](https://github.com/MatterCoder/Matterflow/blob/main/CONTRIBUTING.md) to get started.
---
## Community & Support
For questions or to connect with others, join our [Slack community](https://matterflow.slack.com) or visit our [GitHub repository](https://github.com/MatterCoder/addon-matterflow).
Let’s build and grow this documentation together!
# Website
### Installation
```
$ npm install
```
### Local Development
```
$ npm run start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
### Build
```
$ npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Remote Deployment
This website is running on netlify
