An open API service indexing awesome lists of open source software.

https://github.com/fccn/openedx-corporate

Open edX corporate plugin
https://github.com/fccn/openedx-corporate

Last synced: 4 months ago
JSON representation

Open edX corporate plugin

Awesome Lists containing this project

README

          

corporate-partner-access
############################

A unified LMS plugin for Open edX that consolidates corporate partner needs into a scalable, maintainable solution.

The **corporate-partner-access** plugin addresses the specific requirements of corporate partners by providing a comprehensive system for managing corporate access, user management, and partner-specific features within the Open edX platform. This plugin leverages Open edX's plugin architecture to introduce new data models, APIs, and UI components tailored to corporate use cases.

**Key Features:**

* Unified partner management system
* Corporate access control and user management
* Scalable architecture designed for future growth
* Easy integration with existing Open edX installations
* Partner-specific customizations and features

Current Status
**************

This project is currently in early development with a modular approach to ensure:

* Clean separation of concerns
* Easy testing and maintenance
* Future extensibility
* Seamless integration with Open edX core

Getting Started with Development
********************************

Please see the Open edX documentation for `guidance on Python development`_ in this repo.

.. _guidance on Python development: https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html

Deploying
*********

This plugin is designed for standard installation within a modern Open edX environment.

**Prerequisites:**

* Open edX installation (**Quince** release or later recommended)
* Python **3.11**
* Django **4.2+**

**Basic Installation (Development):**

.. code-block:: bash

# Clone the repository
git clone

# Install in development mode
pip install -e .

# Run migrations
python manage.py migrate

.. note::
Detailed production deployment instructions will be added as the plugin reaches maturity.

Getting Help
************

Documentation
=============

Documentation is currently being developed alongside the plugin. For now, please refer to the source code and inline documentation.

As the project evolves, comprehensive documentation will be available at the standard Open edX documentation site.

More 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 workspace`_.

For anything non-trivial, the best path is to open an issue in this
repository with as many details about the issue you are facing as you
can provide.

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

.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/

License
*******

The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.

Please see `LICENSE.txt `_ for details.

Contributing
************

Please read `How To Contribute `_ for details on the Open edX contribution process.

**Getting Involved:**
1. Check the current issues and milestones
2. Discuss new feature ideas with the maintainers before beginning development
3. Follow Open edX coding standards and best practices
4. Ensure comprehensive test coverage for new features

You can start a conversation by creating a new issue on this repo summarizing your idea or reaching out to the team directly.