Tom Butcher
6dcc5759f4
All checks were successful
farmcontrol/farmcontrol-ui/pipeline/head This commit looks good
- Added a new helper function 'renderDocumentTemplate' to the fcTemplateHelpers for improved document rendering capabilities. - Introduced 'mapObjectFiltersForQuery' function to streamline filter mapping in API requests, enhancing code readability and maintainability. - Updated API server context to utilize the new filter mapping function, improving data fetching logic and consistency in handling object filters. - Refactored sorting parameters in API requests to use 'sortProperty' and 'sortOrder' for better clarity and alignment with naming conventions.
Farm Control UI
Farm Control UI is a modern web application for managing and monitoring farm production, inventory, and operations. This project serves as the frontend for the FarmControl system, providing an intuitive interface for users to interact with various farm management modules.
Features
- Dashboard for real-time monitoring
- Inventory management (Filaments, Parts, Products, Vendors, etc.)
- Production tracking (Jobs, Printers, GCode files)
- User and access management
- Audit logs and activity tracking
- Responsive and user-friendly design
Stack
- React
- Vite
- JavaScript (ES6+)
- [CSS Modules]
- Node.js
Getting Started
Prerequisites
- Node.js (v16 or higher recommended)
- npm (v8 or higher)
Installation
- Clone the repository:
git clone https://github.com/your-org/farmcontrol-ui.git cd farmcontrol-ui - Install dependencies:
npm install
Running the App
To start the development server:
npm run dev
The app will be available at http://localhost:5173.
Building for Production
To build the app for production:
npm run build
The optimized build will be in the build/ directory.
To run the app for production:
npm start
Project Structure
src/
assets/ # Icons, logos, and other static assets
components/ # React components organized by feature/module
config.js # App configuration
index.jsx # App entry point
App.jsx # Main App component
...
public/ # Static public files
scripts/ # Utility scripts (e.g., SVG minification)
License
This project is licensed under the MIT License.