https://github.com/piavgh/react-apps-script-boilerplate
React Apps Script Boilerplate
https://github.com/piavgh/react-apps-script-boilerplate
ant-design apps-script boilerplate react reactjs styled-components template
Last synced: 22 days ago
JSON representation
React Apps Script Boilerplate
- Host: GitHub
- URL: https://github.com/piavgh/react-apps-script-boilerplate
- Owner: piavgh
- License: mit
- Created: 2019-07-05T10:48:19.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-10T09:04:05.000Z (almost 7 years ago)
- Last Synced: 2025-01-22T16:49:53.486Z (over 1 year ago)
- Topics: ant-design, apps-script, boilerplate, react, reactjs, styled-components, template
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## React Apps Script Boilerplate
Boilerplate to start quickly with Apps Script + React
Included Ant Design, styled-components and react-transition-group
## Installation
1. Clone the sample project and install dependencies:
```
git clone https://github.com/piavgh/react-apps-script-boilerplate.git
cd react-apps-script-boilerplate
npm install
```
2. Then [create a new Google Forms](https://forms.google.com). Open the Script Editor and copy the script's scriptId. [**Tools > Script Editor**, then **File > Project properties**].
3. Create file `.clasp.json` by copying `.clasp.json.sample`
4. Paste the **scriptId** into the .clasp.json file as below:
```
// .clasp.json
{"rootDir": "dist",
"scriptId":"...paste scriptId here..."}
```
5. If you have not enabled Google's Apps Script API, do so by visiting https://script.google.com/home/usersettings.
Log into CLASP to push code to the server from the command line:
```
npx clasp login
```
6. Modify the server-side and client-side source code in the `src` folder using ES6/7 and React. Change the scopes in `appsscript.json` if needed. When you're ready, build the app and deploy!
```
npm run deploy
```
Webpack will display any linting errors, bundle your files in `dist`, and push your files to Google's servers using CLASP. You can run `npm run build` to just build.
## How it works
"[Google Apps Script](https://en.wikipedia.org/wiki/Google_Apps_Script) is based on JavaScript 1.6 with some portions of 1.7 and 1.8 and provides subset of ECMAScript 5 API."
That means many JavaScript tools used today in modern web development will not work in the Google Apps Script environment, including `let`/`const` declarations, arrow functions, spread operator, etc.
This project circumvents those restrictions by transpiling newer code to older code that Google Apps Script understands using Babel, and also bundles separate files and modules using Webpack.
On the client-side, there are restrictions on the way HTML dialogs are used in Google Apps (Sheets, Docs and Forms). In web development you can simply reference a separate css file:
```
```
In the Google Apps Script environment you need to use [HTML templates](https://developers.google.com/apps-script/guides/html/templates), which can be cumbersome. With this project, all files are bundled together by inlining .css and .js files. Using a transpiler and bundling tool also allows us to use JSX syntax, and external libraries such as React.
## Features
- Support for JSX syntax:
```
return
Name: {person.firstName}
```
- Support for external packages. Simply install with npm or from a file and `import`:
```
$ npm install react-transition-group
```
- `import` CSS from another file:
```
import "./styles.css";
```
- Make server calls in React with `google.script.run`:
```
componentDidMount() {
google.script.run
.withSuccessHandler((data) => this.setState({names: data}))
.withFailureHandler((error) => alert(error))
.getSheetsData()
}
```
- Use newer ES6/7 code, including arrow functions, spread operators, `const`/`let`, and more:
```
const getSheetsData = () => {
let activeSheetName = getActiveSheetName();
return getSheets().map((sheet, index) => {
let sheetName = sheet.getName();
return {
text: sheetName,
sheetIndex: index,
isActive: sheetName === activeSheetName,
};
});
};
```
## Tern support
This project includes support for GAS definitions and autocomplete through a [Tern](http://ternjs.net/) plugin. Tern is a code-analysis engine for JavaScript, providing many useful tools for developing. See Tern's site for setup instructions for many popular code editors, such as Sublime, Vim and others.
Tern provides many indispensable tools for working with Google Apps Script, such as autocompletion on variables and properties, function argument hints and querying the type of an expression.
- Autocomplete example. Lists all available methods from the appropriate Google Apps Script API:
- Full definitions with links to official documentation, plus information on argument and return type:
## Extending this app
- You can split up server-side code into multiple files and folders using `import` and `export` statements.
- Make sure to expose all public functions including any functions called from the client with `google.script.run` as well as onOpen. Example below shows assignment to `global` object:
```
const onOpen = () => {
FormApp.getUi()
.createAddonMenu()
.addItem('Configure notifications', 'showSidebar')
.addItem('About', 'showAbout')
.addToUi()
}
global.onOpen = onOpen
```
- You may wish to remove automatic linting when running Webpack. You can do so by editing the Webpack config file and commenting out the eslintConfig line in client or server settings:
```
// webpack.config.js
const clientConfig = Object.assign({}, sharedConfigSettings, {
...
module: {
rules: [
// eslintConfig,
{
```