Google Maps XBlock

This XBlock provides a Google Map to an edX course.

Installation

First clone the xblock-google-maps git repository by running the following command:

$ git clone https://github.com/ExtensionEngine/xblock-google-maps.git

After you have cloned the repository you need to install the Google Maps XBlock by running the following command:

$ make requirements

Enabling in Studio

You can enable the Google Maps XBlock in Studio through the advanced settings.

1. From the main page of a specific course, navigate to Settings -> Advanced Settings from the top menu.
2. Check for the Advanced Module List policy key, and add "google_maps" to the policy value list.
3. Click the "Save changes" button.

Adding Google Maps API key

This Xblock requires a Google Maps API key to work properly. Visit https://developers.google.com/maps/documentation/javascript/get-api-key for more instructions about Google Maps API key.

After acquiring the API key, enable the following APIs in the Google Developers Console (https://console.developers.google.com/):

1. Google Maps Embed API
2. Google Maps JavaScript API
3. Google Places API Web Service

Add the following entry to XBLOCK_SETTINGS in both lms.env.json and cms.env.json:

"XBLOCK_SETTINGS": {
    "GoogleMapsXBlock": {
        "API_KEY": "YOUR API KEY GOES HERE"
    }
},

Replace "YOUR API KEY GOES HERE" with the API key.

Compile Sass

This XBlock uses Sass for writing style rules. This Sass is compiled by running the following command:

$ make static

Update translations

Note: Translations currently don't work i.e. they are not displayed in the xblock.

If you are adding new strings to the codebase you should always mark them for translation. To mark a new string for translation in Python do the following:

from .utils import _
_('New string')

to do it in JavaScript:

TBA

and in HTML:

{% load i18n %}

<p>{% trans "New string" %}</p>

Once you have marked all the newly added strings for translations you need to run

$ make extract_translations

to extract them to the initial language's (currently English) .PO file. If you want to initialize a a new language folder you can do it with:

$ make init_translation LANG=<two-character language shortcode>

Once you have extracted the strings you can either translate it manually or run

$ make push_translations

to push them to Transifex. In case you are using Transifex for your translations, once they are translated you'll need to pull them with:

$ make pull_translations

and compile with:

$ make compile_translations

at which point your translations are ready to be used.

License

The Google Maps XBlock is available under the MIT License.