FarmInsight Dashboard Frontend

Table of Contents

• The FarmInsight Project
  • Core vision
• Overview
  • Built with
• Features
• Installation
• Usage
• Screenshots and UI Design
• Contributing
• License

The FarmInsight Project

Welcome to the FarmInsight Project by ETCE!

The FarmInsight platform brings together advanced monitoring of "Food Production Facilities" (FPF), enabling users to document, track, and optimize every stage of food production seamlessly.

All FarmInsight Repositories:

• Dashboard-Frontend
• Dashboard-Backend
• FPF-Backend

Core vision

FarmInsight empowers users to manage food production facilities with precision and ease.

Key features include:

• User Management: Set up organizations with role-based access control for secure and personalized use.
• FPF Management: Configure and manage Food Production Facilities (FPFs), each equipped with sensors and cameras.
• Sensor & Camera Integration: Collect sensor data and capture images or livestreams at configurable intervals, all accessible through the web application.
• Harvest Documentation: Log and track harvests for each plant directly from the frontend interface.
• Data Visualization: Visualize sensor data with intuitive graphs and charts.
• Media Display: View and manage captured images and livestreams for real-time monitoring.

🔎 Overview

The FarmInsight Dashboard Frontend is a user interface for managing and monitoring Food Production Facilities (FPFs). It serves as the frontend for a corresponding backend, which is also hosted in the ETCE-Labs GitHub repository.

The dashboard provides:

• A detailed overview of FPFs.
• Features for creating and editing organizations.
• Assignment of FPFs to organizations.
• User management.
• Management and editing of FPFs:
  • Adding sensors and cameras.
  • Graphical representation and analysis of sensor data.

Built with

🔬 Features

Organizations

• Creation and editing of organizations.
• Assignment of existing users to organizations.
• Promoting or removing users of an organization.

Food Production Facilities (FPFs)

• Creation, management, and editing of FPFs.
• Adding and editing of sensors and cameras.
• Displaying and graphically analyzing sensor data in an intuitive UI.
• Adding, editing, deleting Growing Cycles.

🔧 Installation

System Requirements

• Node.js (recommended: LTS version)

Steps

1. Clone the repository:

   git clone https://github.com/ETCE-LAB/FarmInsight-Dashboard-Frontend.git

2. Install dependencies:

   npm install --force

3. Start the development server:

   npm start

   The development server will run by default at http://localhost:3000.

4. Set up the backend:

   Please follow the instructions in the Backend Repository to set up the API.

💡 Usage

Access

After starting the frontend, you can either create or log in with a user account in order to create your own organizations and FPFs or manage existing ones.

🎨 Screenshots and UI Design

Please insert screenshots or mockups here.

⚖️ License

This project is licensed under the AGPL-3.0 license.

🔄 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/your-feature
3. Make your changes and commit them: git commit -m 'Add new feature'
4. Push the branch: git push origin feature/your-feature
5. Create a pull request.

---

For more information or questions, please contact the ETCE-Lab team.