You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
0x29a 528b96fef9
docs: expand `override_export_fs`'s docstring
2 weeks ago
.github feat: VAN-1221 - POC: Course skills based recommendations from Algolia 2 weeks ago
.tx fix: transifex migration to new client (#30084) 10 months ago
cms feat: add banner to show if new discussion provider is active (#31645) 2 weeks ago
common feat: Learner Home experimental rollout (#31642) 2 weeks ago
conf/locale chore(i18n): update translations (#31640) 2 weeks ago
docs refactor: remove all paver code related to python unit tests (#31180) 3 weeks ago
lms feat: Learner Home experimental rollout (#31642) 2 weeks ago
openedx docs: expand `override_export_fs`'s docstring 2 weeks ago
pavelib refactor: remove all paver code related to python unit tests (#31180) 3 weeks ago
requirements build: Adding new constraint to avoid bleach. (#31661) 2 weeks ago
scripts refactor: remove all paver code related to python unit tests (#31180) 3 weeks ago
test_root Refactor course search into openedx/features 6 years ago
themes fix: fix github url strings (org edx -> openedx) 5 months ago
webpack-config Revert "Revert "refactor: move xmodule folder to root"" 8 months ago
xmodule docs: update VS[compat] comments 2 weeks ago
.annotation_safe_list.yml fix: update repo paths that stayed in the edx org 5 months ago
.babelrc Node Upgrade (#30420) 9 months ago
.coveragerc Revert "Revert "refactor: move common/lib/capa/capa to xmodule/capa" (#30762)" 7 months ago
.coveragerc-local refactor!: delete common/lib and related usages 5 months ago
.dockerignore build: expose working openedx/lms and openedx/cms docker images (#29549) 1 year ago
.editorconfig chore: run Manage local config files from masters in edx_lint. 5 months ago
.eslintignore Revert "Revert "refactor: move common/lib/capa/capa to xmodule/capa" (#30762)" 7 months ago
.eslintrc.json Revert "feat: node16 upgrade (#30249)" (#30268) 10 months ago
.gitattributes vagrant: Prevent git from altering line endings altogether 10 years ago
.gitignore add private.in to .gitignore to align with the instructions in requirements/edx/private.readme 3 years ago
.npmignore Add empty npmignore file, override gitignore for NPM deps. 5 years ago
.npmrc Faster "npm install" without progress bar 4 years ago
.pii_annotations.yml Lower PII annotation threshold so that I can enable enforcement 3 years ago
.readthedocs.yaml docs: Update build operating system. 2 months ago
.stylelintignore Revert "Revert "refactor: move xmodule folder to root"" 8 months ago
CHANGELOG.rst fix: fix github url strings (org edx -> openedx) 5 months ago
CONTRIBUTING.rst fix: Update the slack invite link. 7 months ago
Dockerfile chore: Overhaul Dockerfile for sandboxes (#31232) 2 months ago
LICENSE clarify LICENSE 10 years ago
Makefile fix: remove local setuptools override (#31649) 2 weeks ago
README.rst fix: fix CI badge (#31097) 4 months ago
codecov.yml adjust codecov threshold 6 years ago
conftest.py Applied pylint-amnesty 2 years ago
db_keyword_overrides.yml fix: fix github url strings (org edx -> openedx) 5 months ago
doc.rst.j2 refactor: rename `toggle_warnings` to `toggle_warning` (#30458) 9 months ago
jest.config.js Node Upgrade (#30420) 9 months ago
manage.py refactor: make safe_lxml an ordinary folder in openedx/core/lib (#25689) 9 months ago
mypy.ini feat: run mypy as part of testing the codebase 2 years ago
openedx.yaml This pull request was generated by the cleanup-python-code Jenkins job, which ran 3 years ago
package-lock.json feat: TNL-10136 fix dependencies 2 months ago
package.json feat: TNL-10136 fix dependencies 2 months ago
pavement.py refactor!: delete common/lib and related usages 5 months ago
pylint_django_settings.py fix: bump pylint version (#31084) 3 months ago
pylintrc fix: bump pylint version (#31084) 3 months ago
pylintrc_tweaks fix: bump pylint version (#31084) 3 months ago
requirements.txt feat: TNL-10136 fix build errors 2 months ago
setup.cfg build: add import linter check (#31062) 2 months ago
setup.py refactor: rename HiddenDescriptor to HiddenBlock 2 months ago
setupTests.js Add UI to browse and browse course structure and select the course/chapter/section... to generate a report of 5 years ago
stylelint.config.js Lint Sass files using the rules in stylelint-config-edx 5 years ago
tox.ini build: Set Django version for tests more safely; drop support for non-GHA (#31387) 2 months ago
webpack.common.config.js feat: Add 2U recommendations in dashboard [VAN-1094] (#31026) 5 months ago
webpack.dev.config.js Adds support for enabling custom tinymce plugins in Studio's HTML editor (#25695) 2 years ago
webpack.prod.config.js Adds support for enabling custom tinymce plugins in Studio's HTML editor (#25695) 2 years ago

README.rst

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

#################

Open edX Platform
#################
| |License: AGPL v3| |Status| |Python CI|

.. |License: AGPL v3| image:: https://img.shields.io/badge/License-AGPL_v3-blue.svg
:target: https://www.gnu.org/licenses/agpl-3.0

.. |Python CI| image:: https://github.com/openedx/edx-platform/actions/workflows/unit-tests.yml/badge.svg
:target: https://github.com/openedx/edx-platform/actions/workflows/unit-tests.yml

.. |Status| image:: https://img.shields.io/badge/status-maintained-31c653

Purpose
-------
The `Open edX Platform <https://openedx.org>`_ is a service-oriented platform for authoring and
delivering online learning at any scale. The platform is written in
Python and JavaScript and makes extensive use of the Django
framework. At the highest level, the platform is composed of a
monolith, some independently deployable applications (IDAs), and
micro-frontends (MFEs) based on the ReactJS.

This repository hosts the monolith at the center of the Open edX
platform. Functionally, the edx-platform repository provides two services:

* CMS (Content Management Service), which powers Open edX Studio, the platform's learning content authoring environment; and
* LMS (Learning Management Service), which delivers learning content.

Installation
------------

Installing and running an Open edX instance is not simple. We strongly
recommend that you use a service provider to run the software for you. They
have free trials that make it easy to get started:
https://openedx.org/get-started/

If you will be modifying edx-platform code, the `Open edX Developer Stack`_ (Devstack) is
a Docker-based development environment.

If you want to run your own Open edX server and have the technical skills to do
so, `Open edX Installation Options`_ explains your options.

.. _Open edX Developer Stack: https://github.com/openedx/devstack
.. _Open edX Installation Options: https://openedx.atlassian.net/wiki/spaces/OpenOPS/pages/60227779/Open+edX+Installation+Options

License
-------

The code in this repository is licensed under version 3 of the AGPL
unless otherwise noted. Please see the `LICENSE`_ file for details.

.. _LICENSE: https://github.com/openedx/edx-platform/blob/master/LICENSE


More about Open edX
-------------------

See the `Open edX site`_ to learn more about the Open edX world. You can find
information about hosting, extending, and contributing to Open edX software. In
addition, the Open edX site provides product announcements, the Open edX blog,
and other rich community resources.

.. _Open edX site: https://openedx.org

Documentation
-------------

Documentation can be found at https://docs.edx.org.


Getting Help
------------

If you're having trouble, we have discussion forums at
https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a `Slack
invitation`_, then join our `community Slack team`_.

For more information about these options, see the `Getting Help`_ page.

.. _Slack invitation: https://openedx.org/slack
.. _community Slack team: http://openedx.slack.com/
.. _Getting Help: https://openedx.org/getting-help


Issue Tracker
-------------

We use JIRA for our issue tracker, not GitHub issues. You can search
`previously reported issues`_. If you need to report a problem,
please make a free account on our JIRA and `create a new issue`_.

.. _previously reported issues: https://openedx.atlassian.net/projects/CRI/issues
.. _create a new issue: https://openedx.atlassian.net/secure/CreateIssue.jspa?issuetype=1&pid=11900


How to Contribute
-----------------

Contributions are welcome! The first step is to submit a signed
`individual contributor agreement`_. See our `CONTRIBUTING`_ file for more
information it also contains guidelines for how to maintain high code
quality, which will make your contribution more likely to be accepted.


Reporting Security Issues
-------------------------

Please do not report security issues in public. Please email
security@edx.org.

.. _individual contributor agreement: https://openedx.org/cla
.. _CONTRIBUTING: https://github.com/openedx/edx-platform/blob/master/CONTRIBUTING.rst