In this tutorial, we're going to build a Google Chrome extension to save web content to Cosmic Buckets. Think of it as your personal web clipper.
You just need to have Chrome installed for testing it out and nothing else.
Installing the demo
- Get the source code into your machine by either downloading or cloning the repo, which is located here.
- In Chrome, visit
- Enable Developer mode by ticking the checkbox in the upper-right corner.
- Click on the "Load unpacked extension..." button.
- Select the directory containing your unpacked extension.
- Refresh loaded pages.
You'll now see the extension icon to the right of the Omnibox. Click on it and login with your Cosmic credentials. You can now start saving content to your buckets.
Understanding the Source Code
The defining file in a Chrome extension is the manifest.json file. Most of the fields in the Manifest are self explanatory. Let's go through the major fields, and see what each file do.
manifest_versionis "2". it is very important not change it because it is a sign to chrome to how to compile the extension.
permissionsincludes the permissions which extension needs
storagepermission allows you to store data at "Chrome local storage" which is important to save data across websites and different pages.
https://api.cosmicjs.com/v1permission gives access to retrieve and send data from and to the API anywhere in the extension.
browser_actioncontains "default_icon" and "default_popup" which related with top bar icon and HTML file
content_scriptsthis is an important part which it contains scripts which injected into websites
matches: [*://*/*]tells the browser tp inject the scripts to any protocol [http, https,...] and any domain.
cssfield contains CSS style sheets to be injected
all_framesis true which tells to inject script to all frames like "iframe" tag . it is important to make the extension work everywhere
backgroundinclude background scripts which manage send data to Cosmic and checks authorization
myscript.js file contains all the functions of the extension.
contentscript.js file uses jquery and
myscript.js to manage the extension function is matched websites.
background.js file periodically calls the authorization function and also sends data to the Cosmic bucket.
The advantage of API-first content management systems is that there is no limit as to where you can integrate your app into. Your Cosmic Bucket can thus power your web app, native app, browser extensions or basically anything than can consume an API. If you have any questions, please reach out to us on Twitter or join our Slack community.