Merge pull request #113 from CodeForPhilly/zbl_dev_postusaupdate

Updated README and Sync Down Script

Author: ZacharyLeahan

.env.example

@@ -6,4 +6,21 @@ MONGODB_DOCKER_PORT=27017
 NODE_LOCAL_PORT=6868
 PORT=8080
 PAC_API_BASE_URL=https://app.plantagents.org
-PAC_API_KEY={api key from user on plantagents.org}
+PAC_API_KEY={api key from user on plantagents.org}
+
+# Linode Object Storage Configuration
+AWS_ACCESS_KEY_ID=your-access-key
+AWS_SECRET_ACCESS_KEY=your-secret-key
+AWS_DEFAULT_REGION=us-east-1
+LINODE_BUCKET_NAME=choose-native-plants
+LINODE_ENDPOINT_URL=https://us-east-1.linodeobjects.com
+
+#Source Data Google Sheet Locations
+MASTER_CSV_URL=https://docs.google.com/spreadsheets/d/1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o/export?format=csv&id=1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o&gid=1957761759
+ARTICLES_CSV_URL=https://docs.google.com/spreadsheets/d/1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o/export?format=csv&id=1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o&gid=1051500658
+IMAGE_URLS_SHEET_ID=1A8NGzjm1rm_QXBY3hJicYVK13GiYf-qKrgC71q1l0pQ
+SUPERPLANTS_CSV_URL=https://docs.google.com/spreadsheets/d/1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o/export?format=csv&id=1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o&gid=1087463332
+LOCAL_MAP_CSV_URL=https://docs.google.com/spreadsheets/d/1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o/export?format=csv&id=1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o&gid=2078739318
+CONTACT_SHEET_ID=1q_I2cx0ccaNtynDW491s3HdAXBN_zF9_BoKe7iH-ZLg
+CONTACT_FILES_FOLDER_ID=16fKrgsG0sS9rD9xSrYY_SbGnzLnL3_Ou
+ONLINE_STORES_CSV_URL=https://docs.google.com/spreadsheets/d/1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o/export?format=csv&id=1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o&gid=316834967

.gitignore

@@ -13,3 +13,6 @@ node_modules
 
 # local copy of .env.example
 .env
+
+#You need to get the images from the the linode store via the sync down script not from git.
+/images

README.md

@@ -1,16 +1,39 @@
-# Choose Native Plants (fomerly "PA Wildflower Selector"
+# Choose Native Plants 🌱
 
-A web application that helps US residents find native plants suitable for their gardens. Users can search and filter plants based on various criteria like sun exposure, soil moisture, pollinators attracted, and more. The app also shows where to buy these plants locally.
+<div align="center">
 
-## Features
+![GitHub license](https://img.shields.io/github/license/CodeForPhilly/pa-wildflower-selector)
+![GitHub stars](https://img.shields.io/github/stars/CodeForPhilly/pa-wildflower-selector)
+![GitHub issues](https://img.shields.io/github/issues/CodeForPhilly/pa-wildflower-selector)
 
-- Interactive plant search and filtering
-- Detailed plant information including growing conditions
-- Local nursery finder showing where to buy plants
-- Quick search wizard for beginner gardeners
-- Mobile-friendly responsive design
+**Help US residents find and source native plants for their gardens**
 
-## Architecture
+[Getting Started](#getting-started) •
+[Features](#features) •
+[Architecture](#architecture) •
+[Development](#development) •
+[Database](#database-operations) •
+[Contributing](#contributing)
+
+</div>
+
+## 🌟 Overview
+
+[Choose Native Plants](https://choose-native-plants.com) (formerly "PA Wildflower Selector") is a web application that helps US residents find native plants suitable for their gardens. Users can search and filter plants based on various criteria like sun exposure, soil moisture, pollinators attracted, and more. The app also shows where to buy these plants locally.
+
+<div align="center">
+<img src="app-screenshot.png" alt="Application Screenshot" width="600">
+</div>
+
+## ✨ Features
+
+- 🔍 Interactive plant search with multiple filter options
+- 🌿 Detailed plant information including growing conditions
+- 🏪 Local nursery finder showing where to buy plants
+- 🧙 Quick search wizard for beginner gardeners
+- 📱 Mobile-friendly responsive design
+
+## 🏗️ Architecture
 
 - **Frontend**: Vue.js web application
 - **Backend**: Node.js server
@@ -19,139 +42,65 @@ A web application that helps US residents find native plants suitable for their
 - **Vendor Integration**: PlantagentsAPI for local nursery data
   - [API Documentation](https://app.plantagents.org/swagger/index.html)
 
-## Prerequisites
+## 🚀 Getting Started
 
-1. Docker Desktop installed and running
-2. Git
-3. Access to Code for Philly Slack channel (for env keys and secrets)
+### Prerequisites
 
-## Project setup (Docker Based)
+- Docker Desktop installed and running
+- Git
+- User account with [Code for Philly](https://codeforphilly.org/) 
 
-Join the Code for Philly slack channel and ask for the env key, secrets.yaml, and images.
-
-### 1. Initial Setup
+### Initial Setup
 
 ```bash
 # Clone the repository
 git clone https://github.com/CodeForPhilly/pa-wildflower-selector
 
-```
-git clone https://github.com/CodeForPhilly/pa-wildflower-selector
-```
-
-Then you can install the npm dependencies at the server app and ui app levels:
-
-
-```
+# Navigate to project directory
 cd pa-wildflower-selector
-```
-
-For local development, `docker-compose` is used to create a consistent and disposable environment without any modification to or dependency on software installed to the developer's workstation. This approach also provides close parity between local development and container-based deployment in production to Kubernetes.
-
-Make sure Docker Desktop is running and run this Docker compose command:
-
 
-```
+# Start the Docker environment
 docker compose up -d --build
 ```
 
-## First time and occasional stuff
-If you ran docker compose for the first time, you should see http://localhost:6868/ running with no images or data.
-
-### Copy images to images folder.
-
+### Sync down the database and images locally
+   ```bash
+docker compose --profile tools run --rm sync-down
+   ```
 
-### Populate mongodb based on google sheets plant listing.
+### View the application locally
+After setup, visit http://localhost:6868/ to view the application.
 
-Run:
+## 💾 Database Operations
 
+### MongoDB Connection
 
+Connect to MongoDB using MongoDB Compass with:
 ```
-docker-compose exec app node ./download.js --skip-images
+mongodb://[username]:[password]@localhost:7017/pa-wildflower-selector?authSource=admin
 ```
 
-### Massage the mongodb data so the UI can work with it.
+## 🛠️ Development
 
-Run:
+### Project Structure
 
+- **UI Code**: Located in `src/` directory
+- **Server Code**: Located in the main project directory
 
-```
-docker-compose exec app node massage.js
-```
-
+## 👥 Contributing
 
-### Where is the UI code?
+We welcome contributions from the community! To contribute:
 
-In `src/`.
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
 
-### Where is the server-side app code that answers queries?
-
-In the main folder of the project.
-
-
-## Database Operations
-
-### Querying MongoDB
-You can run these commands in the MongoDB container to check the database state:
-
-```bash
-# Count total plants
-db.plants.count()
-
-# Count plants in Alabama
-db.plants.find({"States": "AL"}).count()
-
-# Find a specific plant
-db.plants.findOne({_id: "Asclepias tuberosa"})
-
-# Count images in Docker container
-docker exec pa-wildflower-selector-app-1 sh -c "ls -1 images/*.jpg | wc -l"
-```
-
-### Data Updates
-To update the plant data and images:
-
-```bash
-# Full update (including image downloads)
-npm run update-data
-
-# Quick update (skip image downloads)
-npm run fast-update-data
-```
-
-### Database Sync
-Two scripts are available for database synchronization:
-
-- `scripts/sync-down.sh`: Downloads MongoDB data and images from remote server
-- `scripts/sync-up.sh`: Uploads local MongoDB data and images to remote server
-
-## Development Environment
-
-### Docker Setup
-The application runs in Docker containers. Key ports:
-- MongoDB: 7017 (host) -> 27017 (container)
-- Application: 6868 (host) -> 8080 (container)
-
-```bash
-# Start the development environment
-docker-compose up -d --build
-
-# View logs
-docker-compose logs -f
-
-# Stop the environment
-docker-compose down
-```
+## 📧 Contact
 
-### Environment Variables
-Copy `.env.example` to `.env` and configure:
-- MongoDB credentials
-- API endpoints
-- Port mappings
+For any questions or inquiries, please email us at [[email protected]](mailto:[email protected]).
 
-### SOURCE DATA
-The source data is from ERA that is populated on a google sheet ("ERA" and "ONLINE" sheets).
-https://docs.google.com/spreadsheets/d/1R_zhN3GUxhDEMlGFMhcPB_gAoaE9IoyWi10I_nM9f3o
+## 📄 License
 
-Citation for the source data:
-United States Department of Agriculture and US Federal Highway Administration. 2017. National database for pollinator-friendly revegetation and restoration. Compiled by Mark W. Skinner, Gretchen LeBuhn, David Inouye, Terry Griswold, and Jennifer Hopwood. Online at . Contact Mark W. Skinner for updates or more information.
+This project is licensed under the MIT License - see the LICENSE file for details.

app-screenshot.png

@@ -24,10 +24,43 @@ services:
       - DB_PASSWORD=$MONGODB_PASSWORD
       - DB_NAME=$MONGODB_DATABASE
       - DB_PORT=$MONGODB_DOCKER_PORT
+      - MASTER_CSV_URL=$MASTER_CSV_URL
+      - ARTICLES_CSV_URL=$ARTICLES_CSV_URL
+      - SUPERPLANTS_CSV_URL=$SUPERPLANTS_CSV_URL
+      - LOCAL_MAP_CSV_URL=$LOCAL_MAP_CSV_URL
+      - ONLINE_STORES_CSV_URL=$ONLINE_STORES_CSV_URL
+      - IMAGE_URLS_SHEET_ID=$IMAGE_URLS_SHEET_ID
+      - CONTACT_SHEET_ID=$CONTACT_SHEET_ID
+      - CONTACT_FILES_FOLDER_ID=$CONTACT_FILES_FOLDER_ID
     stdin_open: true
     tty: true
     volumes:
       - images:/app/images
+  sync:
+    build:
+      context: ./scripts
+      dockerfile: sync-up.Dockerfile
+    depends_on:
+      - mongodb
+    env_file: ./.env
+    profiles:
+      - tools
+    volumes:
+      - ./images:/data/images:ro
+      - ./data:/data/db_dumps
+  sync-down:
+    build:
+      context: ./scripts
+      dockerfile: sync-down.Dockerfile
+    depends_on:
+      - mongodb
+    env_file: ./.env
+    profiles:
+      - tools
+    volumes:
+      - images:/data/images
+      - ./data:/data/db_dumps
+
 volumes:
   db:
   images: