search

appsembler / figures

Reporting and data retrieval app for Open edX
MIT License
44 stars 37 forks source link

Add installation instructions #2

Closed johnbaldwin closed 5 years ago

johnbaldwin commented 6 years ago

Issue formerly: "Add instructions for custom lms.env.json" edx-figures requires new vars to be loaded from the lms.env.json file. Please see here:

Until/unless we get a 'vendor additions' PR implemented upstream, we'll want to add instructions for implementors to update their fork of edx-platform to enable the custom variables required by edx-figures

OmarIthawi commented 6 years ago

@johnbaldwin Echoing my comments from #1, the solution to this issue is to use EDXAPP_LMS_ENV_EXTRA.

Please let me if you have any other questions.

johnbaldwin commented 6 years ago

I need to revisit this issue. Need to add instructions for Appsembler's fork that uses appsembler_api that removes the need to manually update urls.py

    "APPSEMBLER_FEATURES": {
        "LMS_URLS_INCLUDE": [
            [ "^figures/", "edx_figures.urls" ]
        ]
    },
johnbaldwin commented 6 years ago

For devstack, add the following to the Vagrantfile

config.vm.network :forwarded_port, guest: 3000, host: 3000 # edx-figures npm server

This opens up the npm server to serve the bundle in dev mode

johnbaldwin commented 5 years ago

Added installation instructions w/PR https://github.com/appsembler/figures/pull/45

NOTE: I do need to revisit the devstack instructions and we're going to verify Figures this week, so that will be an opportunity to test the instructions.

Since we now have installation documentation, I'm closing this issue. If we need to fix the docs we can open a new issues