87 lines
1.9 KiB
Markdown
87 lines
1.9 KiB
Markdown
# FarmControl UI
|
|
|
|
FarmControl 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](https://reactjs.org/)
|
|
- [JavaScript (ES6+)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
|
|
- [CSS Modules]
|
|
- [Node.js](https://nodejs.org/)
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js (v16 or higher recommended)
|
|
- npm (v8 or higher)
|
|
|
|
### Installation
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://github.com/your-org/farmcontrol-ui.git
|
|
cd farmcontrol-ui
|
|
```
|
|
2. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
### Running the App
|
|
|
|
To start the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
The app will be available at [http://localhost:3000](http://localhost:3000).
|
|
|
|
### Building for Production
|
|
|
|
To build the app for production:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
The optimized build will be in the `build/` directory.
|
|
|
|
To run the app for production:
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
src/
|
|
assets/ # Icons, logos, and other static assets
|
|
components/ # React components organized by feature/module
|
|
config.js # App configuration
|
|
index.js # 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.
|
|
|
|
---
|
|
|
|
_For more information, contact the project maintainers or visit the [FarmControl documentation](https://github.com/your-org/farmcontrol-ui/wiki)._
|