How to install "Figures" appsembler

taufanbudiman · May 15, 2020, 1:37am

I followed this instruction to install figures on Edx Hawthorn

appsembler/figures/blob/master/docs/source/install.rst

.. _install:


**NOTICE:** These instructions are for Ficus and Ginkgo and need to be updated for Hawthorn


==================
Installing Figures
==================

This document describes how to install and configure Figures to run in Open edX.


Please note that we're currently focused on developing and troubleshooting Figures, and *not* general Open edX/devstack issues.

If you encounter any issues with installing or running Figures, please first ensure that your installation is working correctly and that the problem is with Figures. 

Please see the documentation `Installing, Configuring, and Running the Open edX Platform <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/>`__ for guidance in getting Open edX set up.

If you run into issues installing Open edX and cannot find an answer in the above Open edX installation instructions, you can post your issue in Open edX slack #general or #ops channels.

This file has been truncated. show original

when i restart the LMS there is an error like this

where should I set webpack_loader? I did update_assets but webpack-stats.json was not found

anjali · May 15, 2020, 1:36pm

Hi @taufanbudiman
Have you got any solution for this?

I have the same issue, I am using the 0.3.9 build of figures.

taufanbudiman · May 15, 2020, 2:26pm

Not yet, I’m still confused about generating webpacks

taufanbudiman · May 21, 2020, 9:22pm

Hi @anjali
I tried installing with branch build-0.3.9, it worked but the UI was not good. try to install, is it the same as my UI?

anjali · May 22, 2020, 7:32am

@taufanbudiman I am getting the error in branch build-0.3.9

Still I will take a latest pull and try once.

taufanbudiman · May 22, 2020, 12:14pm

Hi @anjali,
how do you install the application?
I installed using pip install https://github.com/appsembler/figures.git@build-0.39

Check branch build-0.3.9. In the folder figures you find webpack-stats.js

taufanbudiman · June 1, 2020, 2:56pm

hi, @anjali, Have you successfully installed? I have succeeded.

Selli · June 1, 2020, 5:05pm

@taufanbudiman

Could you give detailed steps followed to achieve this?

anjali · June 2, 2020, 5:06am

Hello @taufanbudiman, I have not tried after that, can you give me the steps for installation?

taufanbudiman · June 2, 2020, 8:36am

@Selli, @anjali

Enable virtual environment

sudo -H -u edxapp bash
cd
source edxapp_env

Install Figures build-0.3.9

clone figures on folder ~/venvs/edxapp/src/figures , i use version build-0.3.9

git clone -b build-0.3.9 https://github.com/appsembler/figures.git

and then go to the frontend folder, build asset with yarn. First, run yarn to install dependecies and then yarn build to build asset of figures. Frontend assets will be available at ~/venvs/edxapp/src/figures/figures/static . Copy generated frontend assets to staticfiles

cp -r ~/venvs/edxapp/src/figures/figures/static/figures /edx/var/edxapp/staticfiles/

install figures

cd ~/venvs/edxapp/src/figures/
pip install -e .

Add Configuration Settings

cd ~/edx-platform/

Edit lms/envs/production.py and add configuration settings like below

if 'figures.apps.FiguresConfig' in INSTALLED_APPS:
    from figures.settings.lms_production import *
    ENV_TOKENS.setdefault('FIGURES', {})
    update_webpack_loader(WEBPACK_LOADER, ENV_TOKENS['FIGURES'])
    update_celerybeat_schedule(CELERYBEAT_SCHEDULE, ENV_TOKENS['FIGURES'])
    CELERY_IMPORTS += ( 'figures.tasks', )

Edit lms/urls.py and add configuration urls like below

if 'figures' in settings.INSTALLED_APPS:
        urlpatterns += [
                url(r'^figures/', include('figures.urls', namespace='figures')),
        ]

migrate database for figures

~/edx-platform/manage.py lms migrate figures --settings=production

Restart LMS

exit user edxapp and then restart lms.

sudo /edx/bin/supervisorctl restart lms

access figures with https://yourlms.com/figures/

I hope this helps

Xperez · June 27, 2020, 4:43pm

Hi @taufanbudiman im having problems with this step, when accessing the frontend folder if i type

yarn

or

yarn build

It shows me this error:

ERROR: There are no scenarios; must have at least one.

Can you guide me with this step please?

taufanbudiman · June 28, 2020, 2:35pm

Have you activated Virtualenv and run it as edxapp??

Xperez · June 29, 2020, 4:21pm

Hi @taufanbudiman, thanks for your answer

I think that i activate the virtual_env correctly and work as edxapp:

To install figures the first thing i do in the command line is this:

sudo su edxapp -s /bin/bash
cd /edx/app/edxapp
. edxapp_env
. venvs/edxapp/bin/activate

Then git clone the repo:

git clone -b build-0.3.9 GitHub - appsembler/figures: Reporting and data retrieval app for Open edX

And access the frontend folder:

cd frontend

I then type yarn or yarn build and that when i get the errors.

taufanbudiman · June 30, 2020, 12:26am

this my version yarn or node.

maybe you can try uninstalling and reinstalling yarn

Xperez · June 30, 2020, 4:35pm

Thanks a lot, that was exactly the problem, yarn version

Now i can see figures app almost completely, im having just a small problem with the “courses” tab inside figures, it shows nothing, did you have the same problem? I installed the master brach.

This is my LMS LOG (I think the problem is related to the “TemplateDoesNotExist: head-extra.html” error)

Jun 30 16:38:10 X8 [service_variant=lms][django.template][env:sandbox] WARNING [X8 17654] [loader_tags.py:232] - Exception raised while rendering {% include %} for template ‘unknown’. Empty string rendered instead.
Traceback (most recent call last):
File “/edx/app/edxapp/venvs/edxapp/local/lib/python2.7/site-packages/django/template/loader_tags.py”, line 204, in render
template = context.template.engine.get_template(template_name)
File “/edx/app/edxapp/venvs/edxapp/local/lib/python2.7/site-packages/django/template/engine.py”, line 162, in get_template
template, origin = self.find_template(template_name)
File “/edx/app/edxapp/venvs/edxapp/local/lib/python2.7/site-packages/django/template/engine.py”, line 148, in find_template
raise TemplateDoesNotExist(name, tried=tried)
TemplateDoesNotExist: head-extra.html
Jun 30 16:38:10 X8 [service_variant=lms][py.warnings][env:sandbox] WARNING [X8 17647] [filters.py:74] - /edx/app/edxapp/venvs/edxapp/local/lib/python2.7/site-packages/rest_framework/filters.py:74: DeprecationWarni$
DeprecationWarning

Xperez · June 30, 2020, 8:59pm

My error was due to the version being used in my installation:

I tried following the steps above with a master branch, thats why i was getting the TemplateDoesNotExist error.

If you follow the instructions step by step you wont have problems.

Check your yarn version and, if it does not match the screenshoot shared by @taufanbudiman do the following:

sudo apt remove cmdtest (if you have any previous version)

sudo apt remove yarn (just in case)

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -

echo “deb https://dl.yarnpkg.com/debian/ stable main” | sudo tee /etc/apt/sources.list.d/yarn.list

sudo apt-get update

sudo apt-get install yarn

And please, thank the work of Mr @taufanbudiman

kritika_arora · July 23, 2020, 9:06pm

Hi anjali ,
I tried to install figures for the ironwood version and followed these steps:

Activated the edxapp_env
pip install figures .
Added “ADDL_INSTALLED_APPS”: [“figures”]
Screenshot from 2020-07-24 02-35-531366×768 93 KB

Screenshot from 2020-07-24 02-36-111366×768 184 KB

in lms.env.json .
But getting this error :

Xperez · July 24, 2020, 2:22pm

Please follow exactly @taufanbudiman instructions, you wont have any problem.

If so, please paste your error here, but your error seems more like a mistake duplicating the label “Figures”.

kritika_arora · July 25, 2020, 4:17am

@Xperez I followed your steps to install yarn. But faced this problem:

kritika_arora · July 25, 2020, 4:19am

Followed above steps to install yarn but faced this problem. I have native ironwood installation

Topic		Replies	Views
Installing Appsembler "Figures" on Hawthorn devstack Development	0	334	November 11, 2021
Figures with Open edX Ginkgo Found incompatible module Site Operations Help	9	666	September 20, 2021
How to install “Figures” appsembler in koa? Site Operations Help how-to , koa	2	434	April 5, 2022
Ansible playbook error Site Operations Help	2	759	October 21, 2019
/edx/bin/update edx-platform breaks when choosing open-release/hawthorn.master Site Operations Help	1	535	July 30, 2019

How to install "Figures" appsembler

Enable virtual environment

Install Figures build-0.3.9

Add Configuration Settings

Restart LMS

Related Topics