Welcome to the Web Apps SDK for Adobe Business Catalyst wiki!

Web Apps SDK for Adobe Business Catalyst allows web developers to create custom client-side applications that leverage the Business Catalyst system APIs. Used inside any Adobe Business Catalyst site, these applications can enhance the standard functionality and experience of the site.

Here are some resources that should get you introduced to Web Apps SDK:

• Project README
• CONTRIBUTING guide
• Developer Forum
• Issue tracker

Want to learn more about it?

• For SDK and API documentation, visit http:https://docs.businesscatalyst.com/developers

Want to see some examples?

• To get you started faster, we've created some sample applications that you can take and install on any of your Business Catalyst sites. You can get the source code from our Git repository: https://github.com/adobebc/web-apps-sdk/samples

Want to build your own app and include the Web Apps SDK?

• Get it from CDN: https://cdn.worldsecuresystems.com/bcapi/bcapi-0.1.0.min.js
• Get for Git and included in your app: https://github.com/adobebc/web-apps-sdk.git

For setting up bcapi.js project development environment follow the steps below:

• install Git on your computer
• install NodeJS on your computer (optional)
• launch a command line / terminal
• git clone https://github.com/adobebc/bcapi.js.git
• cd sdk
• Download https://cdn.worldsecuresystems.com/bcapi/dev/ci.zip
• Unpack ci.zip into sdk folder.
• npm install -d
• Generate documentation:
  • ./node_modules/.bin/grunt jsdoc
  • Access doc/index.html (for getting started)
• Run unit tests (works on Linux and Mac OS):
  • ./run_specs <browsers absolute path comma separated values> (e.g: ./run_specs /usr/bin/google-chrome,/usr/bin/firefox)
• Run integration tests (works on Linux and Mac OS)
  • ./run_integration <browsers absolute path comma separated values> (e.g: ./run_integration /usr/bin/google-chrome,/usr/bin/firefox)
• Generate a bcapi distribution:
  • ./node_modules/.bin/grunt concat uglify:bcapi_dist
  • Access dist/bcapi-full.js (non minified version of bcapi)
  • Access dist/bcapi-full.min.js (minified version of bcapi)

TBD

We will be carefully reviewing every contribution. Read more about code review guidelines.

• Changelog