To be added here: CI status
In order to sync with Square, you'll need the SQUARE_ACCESS_TOKEN for the respective storefront.
TODO:TODO:TODO:If you want to make a copy, this should work (without being connected to square).
- Clone the Git repository:
git clone https://github.com/kofc7186/fishfry-google-square.git cd fishfry-google-square npm install @google/clasp -g - Make a copy of Master Fish Fry Sheet
- In the new copy that was just created:
- select "File/Project Properties"
- Under info tab, there is a field "script ID"
- Copy the "script ID" to your clipboard
- select "File/Project Properties"
- Edit the .clasp.json in the root directory of the repo with the value you copied in the previous step
- Install the NodeJS package from the git repo:
npm install
- Authenticate and authorize clasp to manipulate the project with the google account that has access to the new copy:
This launches a browser and asks you to login via oauth.
clasp login
- Enable Apps Script API by visiting Apps Script API and toggle Google Apps Script API to ON.
- Modify files locally, then push/pull the changes between your desktop and Google Apps
- clasp push will push the code on your local machine to the Google App
- clasp pull will pull the code from Google App to your local machine
The hosted JSDoc files can be found here.
To generate updated documentation:
TODO:These are classes used to interact with the Google infrastructure.
- Logger
- used to write out text to the debugging logs
- PropertiesService
- Allows scripts to store simple data in key-value pairs scoped to one script, one user of a script, or one document in which an add-on is used.
- Used to retrieve the SQUARE_ACCESS_TOKEN attribute to communicate with Square
- HtmlService
- Service for returning HTML and other text content from a script.
- Used to render HTML forms for user input
- Used to render response to websocket from Square
- UrlFetchApp
- Fetch resources and communicate with other hosts over the Internet.
- Used to make RESTful calls to Square
- SpreadsheetApp
- This class allows users to open Google Sheets files and to create new ones.
- Used to manipulate the main Google Sheet
- DocumentApp
- The document service creates and opens Documents that can be edited.
- Used to retrieve the Print template, create new document based on data from Sheet
- LockService
- Prevents concurrent access to sections of code.
- Used to retrive atomic human interpretable order number (i.e. auto-increment)
- Utilities
- This service provides utilities for string encoding/decoding, date formatting, JSON manipulation, and other miscellaneous tasks.
- Used for date/time formatting
└── src
├── FormatOrder.js - used to take input from Square API and format it to insert into Google Sheets
├── Worksheet.js - manipulation to the Worksheet Transactions
├── doPost.js - webhook callback for Square
├── html - form templates
├── menuItems.js - objects for items customers may order, and what ingredients are contained within each order
├── orm.js - helper functions to manipulate the Google Sheet and Workbooks within
├── printLabels.js - generate label from an order, as well as send the label to the printer spool
├── simulateSquare.js - testing helper to simulate data from Square
├── squareAPI.js - simulate responses from Square's RESTful APIs (used in test only)
└── triggers.js - JavaScript trigger functions (i.e. entry point for Google Sheets)
![thunderliortest[bot] avatar](https://avatars.githubusercontent.com/u/29872114?v=4 "thunderliortest[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent