choppingboard 1.0.2 → 1.0.3

package/README.md

@@ -13,7 +13,7 @@ Chopping Board provides real-time insights into your Salad chopping operations a
 - **Real-time Earnings** - Hourly and daily earnings with automatic updates every 5 minutes
 - **Moving Averages** - 7, 14, 30, 50, and 100-day moving averages for trend analysis
 - **Earnings Predictions** - Estimated daily earnings based on current performance
-- **Reward Management** - Track assign Salad rewards to your sub-accounts
+- **Reward Management** - Track and assign Salad rewards to your sub-accounts
 
 ### Energy Monitoring
 - **TPLink Integration** - Monitor electricity consumption via TPLink smart meters
@@ -47,18 +47,31 @@ Chopping Board provides real-time insights into your Salad chopping operations a
 
 ## Installation
 
-### 1. Install Package
+### 1. Install Node.js and npm
+
+If you don't have Node.js installed, download and install it from the official website:
+
+**[Download Node.js](https://nodejs.org/)** - Choose the LTS (Long Term Support) version
+
+This will install both Node.js and npm. Verify the installation by running:
+
+```bash
+node --version
+npm --version
+```
+
+### 2. Install Package
 
 ```bash
 npm install choppingboard-opensource
 ```
 
-### 2. Configure Application
+### 3. Create Your Server File
 
-Edit `example.js` and set your configuration:
+Create a new file (e.g., `server.js` or `index.js`) in your project:
 
 ```javascript
-const { start } = require('./app');
+const { start } = require('choppingboard-opensource');
 const path = require('path');
 
 const server = start({
@@ -68,7 +81,7 @@ const server = start({
 });
 ```
 
-### 3. Get Your Salad Auth Token
+### 4. Get Your Salad Auth Token
 
 To obtain your Salad authentication token:
 
@@ -77,23 +90,34 @@ To obtain your Salad authentication token:
 3. Go to the **Application** or **Storage** tab
 4. Find **Cookies** → `https://app.salad.com`
 5. Copy the value of the authentication cookie
-6. Paste into `example.js` replacing `'YOUR_SALAD_AUTH_TOKEN_HERE'`
+6. Paste into your server file replacing `'YOUR_SALAD_AUTH_TOKEN_HERE'`
 
 > **Note:** You can also update the token later through the web dashboard under "Settings" → "Auth Token"
 
-### 4. Start the Server
+### 5. Start the Server
+
+Run your server file:
 
-**Production:**
 ```bash
-npm start
+node server.js
 ```
 
-**Development (with auto-reload):**
+Or add a start script to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "start": "node server.js"
+  }
+}
+```
+
+Then run:
 ```bash
-npm run dev
+npm start
 ```
 
-### 5. Access Dashboard
+### 6. Access Dashboard
 
 Open your browser and navigate to:
 ```
@@ -106,14 +130,21 @@ The database will automatically initialize on first run.
 
 ### Application Settings
 
-Configure via `example.js` or through the web dashboard:
+Configure via your server file or through the web dashboard:
 
 | Setting | Description | Default |
 |---------|-------------|---------|
 | `port` | Server port number | `3001` |
 | `databasePath` | SQLite database file location | `./data/salad.db` |
 | `saladAuthToken` | Salad API authentication token | Required |
-| Refresh Interval | Data collection frequency (minutes) | `2` |
+
+### Dashboard Settings (via Web Interface)
+
+Additional settings configurable through the web dashboard under "App Settings":
+
+| Setting | Description | Default |
+|---------|-------------|---------|
+| Dashboard Refresh Interval | How often the dashboard polls the server (minutes) | `2` |
 | KWh Price | Electricity cost per kilowatt-hour | `0.105` |
 
 ### Database Location
@@ -122,15 +153,17 @@ The SQLite database is stored at the path specified in `databasePath`. The `data
 
 **Default:** `./data/salad.db`
 
-### Data Collection Interval
+### Data Collection vs Dashboard Refresh
 
-Data is automatically fetched from Salad's API every **5 minutes** by default. This can be modified in `app.js` (line 106):
+**Data Collection Interval (Server-side):**
+- The server automatically fetches data from Salad's API every **5 minutes** (hardcoded)
+- This includes earnings data, machine status, and TPLink meter readings
+- Cannot be changed via dashboard settings
 
-```javascript
-setInterval(async () => {
-  await periodicCheck();
-}, 300000); // 300000ms = 5 minutes
-```
+**Dashboard Refresh Interval (Client-side):**
+- Controls how often your browser refreshes the dashboard data from the server
+- Configurable in "App Settings" (default: 2 minutes)
+- Only affects how often the dashboard updates, not how often data is collected
 
 ## Usage
 
@@ -269,46 +302,31 @@ The application uses SQLite with the following tables:
 
 ## Development
 
-### Project Structure
+### For Contributors
 
-```
-open-source-stack/
-├── app.js                    # Main server initialization
-├── example.js                # Entry point and configuration
-├── package.json              # Dependencies and scripts
-├── lib/
-│   ├── database.js          # Database schema and connection
-│   └── queries.js           # Database query functions
-├── service/
-│   └── app.js               # Salad API and TPLink integration
-├── website/
-│   ├── app.js               # Express application setup
-│   ├── routes/
-│   │   └── router.js        # Route handlers
-│   ├── views/
-│   │   ├── index.ejs        # Main dashboard template
-│   │   ├── head.ejs         # HTML head section
-│   │   ├── header.ejs       # Navigation bar
-│   │   └── scripts.ejs      # JavaScript includes
-│   └── public/              # Static assets (CSS, fonts, images)
-└── data/
-    └── salad.db             # SQLite database (auto-created)
-```
-
-### Running in Development Mode
+If you want to contribute to Chopping Board or modify the source code:
 
-Use nodemon for automatic server restart on file changes:
+1. Clone the repository:
+```bash
+git clone <repository-url>
+cd open-source-stack
+npm install
+```
 
+2. Run in development mode with auto-reload:
 ```bash
 npm run dev
 ```
 
-### Adding New Features
+3. The project structure includes:
+   - `app.js` - Main server initialization
+   - `lib/` - Database schema and queries
+   - `service/` - Salad API and TPLink integration
+   - `website/` - Express routes, views, and static assets
+
+### Extending Functionality
 
-1. **Routes**: Add endpoints in `website/routes/router.js`
-2. **Database Queries**: Add functions in `lib/queries.js`
-3. **API Integration**: Extend `service/app.js` for external APIs
-4. **UI**: Modify templates in `website/views/`
+The module exports a `start()` function that initializes the server. Advanced users can access internal components by exploring the module structure, though the primary interface is the configuration object passed to `start()`.
 
 ## Troubleshooting
 
@@ -323,7 +341,7 @@ npm run dev
 ### Authentication Issues
 
 **Issue:** `401 Unauthorized` from Salad API
-- **Solution:** Update your Salad auth token in the dashboard or `example.js`
+- **Solution:** Update your Salad auth token in the dashboard or in your server file
 
 **Issue:** Token expired
 - **Solution:** Log into Salad dashboard and retrieve a fresh authentication token
@@ -339,7 +357,7 @@ npm run dev
 ### Port Already in Use
 
 **Issue:** `EADDRINUSE: address already in use :::3001`
-- **Solution:** Change the port in `example.js` or stop the process using port 3001
+- **Solution:** Change the port in your server file or stop the process using port 3001
 
 ```bash
 # Find process using port 3001

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "choppingboard",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Salad monitoring server as an npm module with SQLite backend",
   "main": "app.js",
   "scripts": {