cloudflare / embed-box

Universal install guide for embed codes and CMS plugins.
http://embedbox.io
MIT License
78 stars 12 forks source link

EmbedBox

CircleCI npm version Open Source Love PRs Welcome

EmbedBox is an open-source UI you can simply drop in to provide instructions for installing your embed code or plugins on every major CMS.

Learn how to use EmbedBox in your own project.

Contributing

We would love for this to become a project of the community. Feel free to open an issue, submit a PR or contribute to the docs.

Adding instructions for more CMS platforms

EmbedBox currently has instructions for all of the most popular CMS platforms, including WordPress, Weebly, Joomla, and Drupal, and we plan to continue to add more over time.

We’re planning to add more targets over time. You can track our progress in Project #1. The more CMS instructions we can add, the more useful and powerful EmbedBox will become. Follow these guidelines when contributing docs for new “targets” (what the EmbedBox codebase calls CMS platforms).

Requirements

Node v5.0.0+

Development

npm install
npm start

Then navigate to http://localhost:9000

For a breakdown of how EmbedBox is built, check out our design architecture docs.

Testing

cd ./test
npm install
npm test

Then navigate to http://localhost:9001

Releases

EmbedBox uses semantic versioning

npm run release 1.2.3
git push && git push --tags && npm publish

Companies using EmbedBox

Let us know if you’d like your product be added to this list!