(Beta) Node Weebly CLI

This repository is currently in beta testing and development.

Command Line Interface (CLI) utility for helping Weebly Developers build apps quicker and easier for App Center and with fewer issues.

The Weebly CLI is open source software which empowers developers to quickly scaffold their Weebly applications.

There are four (4) primary types of apps developers can create:

• Elements
• Dashboard Cards
• Backend Services
• Snippets

Developers can also create custom Themes, however the Weebly CLI does not support themes at this time.

Please see our milestones and issues page to contribute to this open source community resource for Weebly developers.

Prerequsites

Prior to using the weebly init command to initialize a new Weebly app, you will need to have defined the app on Weebly Developer Admin Portal first, your client_id will be required to access any of the Weebly APIs or to subscribe and use Weebly Webhooks.

You will need:

• callback_url = Endpoint in your app to handle App Installation and Authorization
• client_id = Unique identifier for your app, provided by Weebly Developer Admin Portal
• manage_url = [OPTIONAL] Endpoint in your app for users to configure/manage their instance's settings of your app on their site
• Webhook callback_url = [OPTIONAL] Endpoint in your app if you plan to consume Weebly Webhooks

Getting Started

1. Install the Weebly CLI: npm i -g node-weebly
2. View list of commands with help: weebly -h -OR- weebly --help
3. Initialize a new Weebly App: weebly init
4. Change your working directory into the newly created Weebly App Directory cd <YOUR APP DIR NAME>

Usage

• weebly init - Creates a new Weebly app project directory and dependencies
• weebly list <type> - List of different type of apps
• weebly add <type> - Adds a new app type can be: "element", "dashboard-card", or "webhook"
• weebly delete <type> <name> - Deletes a type of app by name
• weebly validate - Validates that your app's manifest.json is valid

Authors

• Daniel Lett
• Robin Whitmore
• Benjamin Dean

Contributing

Please see the full CONTRIBUTING to learn how to:

• Submit new issues
• Engage on existing issues
• Contribute source code

LICENSE

Please see the full LICENSE file for complete information.

Questions?

If you have any questions or feature requests pertaining to Weebly or this developer tool, please consider asking in either:

• Weebly Developer Community
• Issue Tracker

For discretionary developer support issues, please contact us at [email protected], and we'll be happy to lend a hand!