https://github.com/macagua/centromontessori-edx-ecommerce-theme
A open-edX platform theme for E-learning and E-Commerce Webapps Solutions development by Centro Educativo Montessori
https://github.com/macagua/centromontessori-edx-ecommerce-theme
edx edx-theme koa open-edx openedx-koa-theme tutor
Last synced: 9 months ago
JSON representation
A open-edX platform theme for E-learning and E-Commerce Webapps Solutions development by Centro Educativo Montessori
- Host: GitHub
- URL: https://github.com/macagua/centromontessori-edx-ecommerce-theme
- Owner: macagua
- License: agpl-3.0
- Created: 2022-09-29T20:49:52.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-09-29T21:17:15.000Z (about 3 years ago)
- Last Synced: 2025-01-09T10:49:35.677Z (11 months ago)
- Topics: edx, edx-theme, koa, open-edx, openedx-koa-theme, tutor
- Language: SCSS
- Homepage:
- Size: 220 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
Centro Educativo Montessori E-Commerce theme
============================================
Centro Educativo Montessori Debraning is an elegant, customizable theme for
`Open edX `_'s `E-Commerce `_
Webapp extension.
.. figure:: ./screenshots/01-landing-page-ecommerce.jpg
:alt: Platform landing page for E-Commerce Webapp
:align: center
:width: 1280px
:height: 960px
Platform landing page for E-Commerce 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 Centro Educativo Montessori Debraning E-Commerce theme
is compatible with the Koa release of Open edX.
You can view the theme in action at https://ecommerce.centromontessori.edu.mx/courses.
Installation
------------
Centro Educativo Montessori Debraning E-Commerce was specially developed to be used with
`Tutor `_ (at least v11.0.0) and
`uabierta-ecommerce-theme `_.
If you have not installed Open edX with Tutor, then installation instructions will vary.
Clone the theme repository::
git clone https://github.com/macagua/centromontessori-edx-ecommerce-theme
Render your theme::
tutor config render --extra-config ./centromontessori-edx-ecommerce-theme/config.yml \
./centromontessori-edx-ecommerce-theme/ \
"$(tutor config printroot)/env/build/openedx/themes/centromontessori-edx-ecommerce-theme"
Stop your platform::
tutor local stop
Rebuild the Openedx docker image::
tutor images build openedx
Restart your platform::
tutor local start -d
You will then have to enable the "centromontessori-edx-ecommerce-theme" theme, as per the
`Tutor documentation `_::
tutor local settheme centromontessori-edx-ecommerce-theme ecommerce \
$(tutor config printvalue ECOMMERCE_HOST)
Upgrade
-------
To upgrade the Centro Educativo Montessori Debraning E-Commerce theme from a previous version,
simply pull the changes from the git repository::
cd centromontessori-edx-ecommerce-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 ./centromontessori-edx-ecommerce-theme/config.yml \
--extra-config ./centromontessori-edx-ecommerce-theme/config-custom.yml \
./centromontessori-edx-ecommerce-theme \
"$(tutor config printroot)/env/build/openedx/themes/centromontessori-edx-ecommerce-theme"
Changing the default logo and other images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The theme images are stored in `centromontessori-edx-ecommerce-theme/static/images `_
for the E-Commerce Webapp. To use custom images in your theme, just replace the files stored in these folders
with your own prior to running ``tutor config render``.
Palette colors
~~~~~~~~~~~~~~
- Icon color: #71bd1f
- Background color: #f7f7f7
- Words color: #4c4c4c
License
-------
This work is licensed under the terms of the `GNU Affero General Public License (AGPL) `_.