# @sheetbase/app-scripts
**Scripts for Sheetbase backend modules and apps.**
- [Install](#install)
- [Global](#global)
- [Local](#local)
- [Ayedocs plugins](#ayedocs-plugins)
- [Sheetbase template](#sheetbase-template)
- [Sheetbase installation template](#sheetbase-installation-template)
- [Sheetbase routing template](#sheetbase-routing-template)
- [Command overview](#command-overview)
- [Command reference](#command-reference)
- [`build`](#command-build)
- [`push`](#command-push)
- [`help`](#command-help)
- [Detail API reference](https://sheetbase.github.io/app-scripts)
## Install
### Global
`$ npm install -g @sheetbase/app-scripts`
Command: `sheetbase-app-scripts`
### Local
`$ npm install --save-dev @sheetbase/app-scripts`
Add these lines to the project `package.json`.
```json
{
"scripts": {
"build": "sheetbase-app-scripts build"
}
}
```
## Ayedocs plugins
This package provides Ayedocs templates and converts for conviniently document generation for Sheetbase server modules.
### Sheetbase template
Included all sections:
- Installation
- Options
- Main properties & methods
- Routing
```js
const sheetbaseTemplate = require("@sheetbase/app-scripts/ayedocs-plugins/sheetbase.template");
module.exports = {
fileRender: {
"sheetbase.md": sheetbaseTemplate(),
"sheetbase-full.md": sheetbaseTemplate(true),
},
};
```
### Sheetbase installation template
Common installation & basic usage section.
```js
const sheetbaseInstallationTemplate = require("@sheetbase/app-scripts/ayedocs-plugins/sheetbase-installation.template");
module.exports = {
fileRender: {
"sheetbase-installation.md": sheetbaseInstallationTemplate(),
"sheetbase-installation-full.md": sheetbaseInstallationTemplate(true),
},
};
```
### Sheetbase routing template
Showing **endpoint**, **default disabled routes**, **routing errors** and **the list of routes**.
```js
const sheetbaseRoutingTemplate = require("@sheetbase/app-scripts/ayedocs-plugins/sheetbase-routing.template");
module.exports = {
fileRender: {
"sheetbase-routing.md": sheetbaseRoutingTemplate(),
"sheetbase-routing-full.md": sheetbaseRoutingTemplate(true),
},
};
```
Scripts for Sheetbase backend modules and apps.
- [`sheetbase-app-scripts build`](#command-build)
- [`sheetbase-app-scripts push --copy [value] --vendor [value]`](#command-push)
- [`sheetbase-app-scripts help`](#command-help)
Build distribution package.
Push to the Apps Script server.
**Options**
- `--copy [value]`: Copied resources, comma-seperated.
- `--vendor [value]`: Files for @vendor.js, comma-seperated.
Display help.
## License
**@sheetbase/app-scripts** is released under the [MIT](https://github.com/sheetbase/app-scripts/blob/master/LICENSE) license.
---
⚡️ This document is generated automatically using [@lamnhan/ayedocs](https://github.com/lamnhan/ayedocs).