https://github.com/macagua/bellaelearning-edx-theme
A open-edX platform theme for E-learning Web Solution development by BellaGLOBAL LLC.
https://github.com/macagua/bellaelearning-edx-theme
e-learning edx edx-theme koa open-edx openedx-koa-theme
Last synced: 3 months ago
JSON representation
A open-edX platform theme for E-learning Web Solution development by BellaGLOBAL LLC.
- Host: GitHub
- URL: https://github.com/macagua/bellaelearning-edx-theme
- Owner: macagua
- License: agpl-3.0
- Created: 2022-09-29T20:23:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-29T21:22:45.000Z (over 2 years ago)
- Last Synced: 2025-01-09T10:49:35.816Z (4 months ago)
- Topics: e-learning, edx, edx-theme, koa, open-edx, openedx-koa-theme
- Language: SCSS
- Homepage:
- Size: 1.4 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
Bella Debraning theme for Open edX
==================================
Bella Debraning is an elegant, customizable theme for `Open edX `__.
.. figure:: ./screenshots/01-landing-page-ecommerce.jpg
:alt: Platform landing page for E-learning Webapp
:align: center
:width: 1280px
:height: 960px
Platform landing page for E-learning Webapp
.. figure:: ./screenshots/02-landing-page-studio.jpg
:alt: Platform landing page for Studio Webapp
:align: center
:width: 1280px
:height: 960px
Platform landing page for Studio Webapp
**Note**: This version of the Bella Debraning theme is compatible with the Koa release of Open edX.
You can view the theme in action at http://demo.openedx.overhang.io.
Installation
------------
Bella Debraning was specially developed to be used with `Tutor `__ (at least v11.0.0). If you have not installed Open edX with Tutor, then installation instructions will vary.
Clone the theme repository::
git clone https://github.com/macagua/bellaelearning-edx-theme.git
Render your theme::
tutor config render --extra-config ./bellaelearning-edx-theme/config.yml ./bellaelearning-edx-theme/theme "$(tutor config printroot)/env/build/openedx/themes/bellaelearning-edx-theme"
Rebuild the Openedx docker image::
tutor images build openedx
Restart your platform::
tutor local start -d
You will then have to enable the "bellaelearning-edx-theme" theme, as per the `Tutor documentation `__::
tutor local settheme bellaelearning-edx-theme localhost studio.localhost \
$(tutor config printvalue LMS_HOST) $(tutor config printvalue CMS_HOST)
Upgrade
-------
To upgrade the Bella Debraning theme from a previous version, simply pull the changes from the git repository::
cd bellaelearning-edx-theme/
git pull
Then run the commands above starting from ``tutor config render...``.
Customization
-------------
Setting custom values
~~~~~~~~~~~~~~~~~~~~~
A few settings in the theme can be easily customised: this includes the theme primary color, landing page tagline, footer legal links. Theme settings are defined in the `config.yml `__ file at the root of the repository. You can override all or part of those settings by creating you own ``config-custom.yml`` file. Then, render the theme with::
tutor config render \
--extra-config ./bellaelearning-edx-theme/config.yml \
--extra-config ./bellaelearning-edx-theme/config-custom.yml \
./bellaelearning-edx-theme/theme "$(tutor config printroot)/env/build/openedx/themes/bellaelearning-edx-theme"
Changing the default logo and other images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The theme images are stored in `bellaelearning-edx-theme/theme/lms/static/images `__ for the LMS, and in `bellaelearning-edx-theme/theme/cms/static/images `__ for the CMS. To use custom images in your theme, just replace the files stored in these folders with your own prior to running ``tutor config render``.
Overriding the default "about", "contact", etc. static pages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
By default, the ``/about`` and ``/contact`` pages contain a simple line of text: "This page left intentionally blank. Feel free to add your own content". This is of course unusable in production. In the following, we detail how to override just any of the static templates used in Open edX.
The static templates used by Open edX to render those pages are all stored in the `edx-platform/lms/templates/static_templates `__ folder. To override those templates, you should add your own in the following folder::
ls "$(tutor config printroot)/env/build/openedx/themes/bellaelearning-edx-theme/lms/templates/static_templates"
For instance, edit the "donate.html" file in this directory. We can derive the content of this file from the contents of the `donate.html `__ static template in edx-platform::
<%page expression_filter="h"/>
<%! from django.utils.translation import ugettext as _ %>
<%inherit file="../main.html" />
<%block name="pagetitle">${_("Donate")}%block>
<%block name="pageheader">${page_header or _("Donate")}%block>
<%block name="pagecontent">Add a compelling message here, asking for donations.%block>
This new template will then be used to render the ``/donate`` url.
License
-------
This work is licensed under the terms of the `GNU Affero General Public License (AGPL) `_.