SmartCane/webapps/sugar_mill_locator/README.md

Sugar Cane Mills Locator

Interactive map showing sugar cane mill locations across East & Southern Africa.

Features

View Mode

• Interactive Map: Browse all sugar cane mills on a map
• Color by Country: Each country has a distinct color for easy identification
• Size by Production: Circle size represents annual sugar production
  • Small circles: < 50k tons/year
  • Medium circles: 50-150k tons/year
  • Large circles: > 150k tons/year
• Detailed Popups: Click any mill to see full details:
  • Company, crushing capacity, production volume
  • Coordinates and year of data
  • Notes about the facility

Draw & Add Mode

• Draw Points: Add new mill locations by clicking on the map
• Data Entry Form: Fill in details for each drawn point
• Edit Form Fields:
  • Mill/Factory name (required)
  • Country (required)
  • Company
  • Province/Region
  • Crushing capacity & annual production
  • Notes and data year
• Export & Send: Two options:
  1. Download CSV - Save locally and send manually (secure, no internet required)
  2. Email Directly - Opens your email client pre-filled with data (instant, transparent)

How to Use

Viewing Existing Mills

1. Open the website
2. Click on any mill marker to see detailed information
3. Use the legend to filter by country mentally
4. Zoom in/out to explore regions

Adding New Mills

1. Click the "Draw & Add" button in the header
2. Click the marker tool (in the map's drawing toolbar)
3. Click on the map where you want to add a mill
4. Fill in the popup form with mill details (minimum: name & country)
5. Click "Save" to add more mills
6. When done, click "Export as CSV" to export
7. Choose your export option:
   • Download CSV: Save to your computer, email manually (secure)
   • Email Directly: Opens your email client pre-filled with data (instant)
8. Timon receives and integrates the data

Updating Existing Data

• Currently, updates must be sent as exported CSV files
• Contact team lead to integrate changes into the main database

Data Format

The CSV file contains these columns:

Country,Mill/Factory,Company,Province/Region,Latitude,Longitude,Crushing Capacity (tons/year),Annual Sugar Production (tons),Notes,Data Year

When exporting new additions, the format is identical for easy merging.

Technical Details

• Map Library: Leaflet.js
• Drawing Tools: Leaflet-Draw
• Base Map: OpenStreetMap
• Data Source: CSV file (no backend required)
• Hosting: Can be deployed to Netlify or any static host

Files

• index.html - Main webpage
• app.js - Map logic and interactions
• sugar_cane_factories_africa.csv - Mill location data

---

Last Updated: December 2025