docs: add project documentation, memory, and setup guides
This commit is contained in:
46
README.md
Normal file
46
README.md
Normal file
@ -0,0 +1,46 @@
|
||||
# Product Inventory Management
|
||||
|
||||
This project integrates Google Sheets with Shopify to manage product inventory, photos, and metadata. It uses Google Apps Script to synchronize data between a "master" Google Sheet and your Shopify store.
|
||||
|
||||
## Overview
|
||||
|
||||
The system allows you to:
|
||||
- Manage product details (SKUs, titles, descriptions) in a Google Sheet.
|
||||
- Automatically upload product photos from Google Drive to Shopify.
|
||||
- specific triggers (`onEdit`, `onOpen`) to sync changes to Shopify in real-time or on-demand.
|
||||
- Handle rate limiting and concurrency using a custom queue system.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- **Node.js**: managed via `fnm` (Fast Node Manager)
|
||||
- **Google Clasp**: for pushing code to Apps Script
|
||||
- **Google Cloud Project**: tied to the Apps Script container
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. **Install Dependencies**
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
2. **Build Project**
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
3. **Deploy to Apps Script**
|
||||
```bash
|
||||
npm run deploy
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `src/`: Source code (TypeScript)
|
||||
- `src/config.ts`: Configuration loading from Sheets
|
||||
- `src/global.ts`: Entry points for Apps Script
|
||||
- `src/shopifyApi.ts`: Shopify Admin API wrapper
|
||||
- `src/onEditQueue.ts`: Concurrency management
|
||||
|
||||
For more details, see:
|
||||
- [Architecture Guide](docs/ARCHITECTURE.md)
|
||||
- [Setup Guide](docs/SETUP.md)
|
||||
Reference in New Issue
Block a user