@sheetbase/server-scripts

Scripts for Sheetbase server modules and apps.

   [![License][license_badge]][license_url] [![Support me on Patreon][patreon_badge]][patreon_url] [![PayPal][paypal_donate_badge]][paypal_donate_url] [![Ask me anything][ask_me_badge]][ask_me_url]

[license_badge]: https://img.shields.io/github/license/mashape/apistatus.svg
[license_url]: https://github.com/sheetbase/server-scripts/blob/master/LICENSE
[patreon_badge]: https://lamnhan.github.io/assets/images/badges/patreon.svg
[patreon_url]: https://www.patreon.com/lamnhan
[paypal_donate_badge]: https://lamnhan.github.io/assets/images/badges/paypal_donate.svg
[paypal_donate_url]: https://www.paypal.me/lamnhan
[ask_me_badge]: https://img.shields.io/badge/ask/me-anything-1abc9c.svg
[ask_me_url]: https://m.me/sheetbase

- Install
- Global
- Local
- Ayedocs plugins
- Sheetbase template
- Sheetbase installation template
- Sheetbase routing template
- Command overview
- Command reference
- build
- deploy
- help
- Detail API reference

Install

$3

$ npm install -g @sheetbase/server-scripts

Command: sheetbase-server-scripts

$3

$ npm install --save-dev @sheetbase/server-scripts

Add these lines to the project package.json.

``json
{
"scripts": {
"build": "sheetbase-server-scripts build"
}
}
`

Ayedocs plugins

This package provides Ayedocs templates and converts for conviniently document generation for Sheetbase server modules.

$3

Included all sections:

- Installation
- Options
- Main properties & methods
- Routing

`js
const sheetbaseTemplate = require("@sheetbase/server-scripts/ayedocs-plugins/sheetbase.template");

module.exports = {
fileRender: {
"sheetbase.md": sheetbaseTemplate(),
"sheetbase-full.md": sheetbaseTemplate(true),
},
};
`

$3

Common installation & basic usage section.

`js
const sheetbaseInstallationTemplate = require("@sheetbase/server-scripts/ayedocs-plugins/sheetbase-installation.template");

module.exports = {
fileRender: {
"sheetbase-installation.md": sheetbaseInstallationTemplate(),
"sheetbase-installation-full.md": sheetbaseInstallationTemplate(true),
},
};
`

$3

Showing endpoint, default disabled routes, routing errors and the list of routes.

`js
const sheetbaseRoutingTemplate = require("@sheetbase/server-scripts/ayedocs-plugins/sheetbase-routing.template");

module.exports = {
fileRender: {
"sheetbase-routing.md": sheetbaseRoutingTemplate(),
"sheetbase-routing-full.md": sheetbaseRoutingTemplate(true),
},
};
`

Command overview

Scripts for Sheetbase server modules and apps.

- sheetbase-server-scripts build
- [sheetbase-server-scripts deploy --dry-run --copy [value] --vendor [value]](#command-deploy)
- sheetbase-server-scripts help

Command reference

build

Build distribution package.

deploy

Push to the Apps Script server.

Options

- -d, --dry-run: Staging only.
- --copy [value]: Copied resources, comma-seperated.
- --vendor [value]`: Files for @vendor.js, comma-seperated.

help

Display help.

License

@sheetbase/server-scripts is released under the MIT license.

---

⚡️ This document is generated automatically using @lamnhan/ayedocs.