Welcome to the Sherab Project. This repository contains the central documentation, technical setup instructions, and operational procedures for our customized Open edX deployment.
If you are new to the team, please read these files in strict order. They are designed to hold your hand through the entire setup of our platform.
- 📘 00. Getting Started: Global Prerequisites
- ⬆️ 01. Tutor Installation & Upgrade Guide
- ⚙️ 02. Tutor Setup & Customization Guide
- 🧩 03. Mounting Frontend MFEs
- 🛒 04. Setting Up E-commerce for Sherab
- 📱 05. Android App Development Environment Setup
- 🔁 16. Development, Testing & Deployment Workflow
Once you're set up, refer to these documents for specific administrative tasks and deployments:
- 🤝 06. Partner-Organization Mapping
- 🚩 07. Open edX Feature Flags
- 🌐 08. Transifex Setup & Management
- 🔄 09. Tutor Server Migration Guide
- 🚑 10. Troubleshooting Common Issues
- 🚀 11. Advanced Plugins & Translations
- 🧩 12. Custom ORA Component Setup
- 🗄️ 13. S3 Plugin Setup
- 🎨 14. Header, Footer & Brand Component Overrides
- 🌐 15. MFE Localization & Translation Setup
These are our core repositories maintained under the Sherab project by OpenPecha.
1. Sherab Theme
A custom theme for Open edX tailored for the Sherab learning platform, including branding, styles, and logos.
2. edx-platform
Our custom fork of the Open edX core codebase.
A Django plugin extending core functionality with Sherab-specific backend logic and custom app APIs.
We also utilize the default enabled MFEs from Open edX (Authn, Authoring, Account, Communications, Discussions, Gradebook, Learning, ORA Grading, Profile).
We welcome contributions from the community! Here's how you can get involved:
If you encounter a bug or unexpected behavior:
- Open an issue in the respective repository
- Describe the problem clearly and include steps to reproduce it if possible
- This helps us track and resolve issues efficiently
Want to contribute code? Follow these steps:
- Create a feature branch off the
wbc-ulmo1-stagebranch in the respective repository - Make your changes and commit them.
- Open a Pull Request (PR) to the
wbc-ulmo1-stagebranch. - One of the Sherab developers will review and test your contribution.
- After approval, the changes will be merged into production.
🔒 Note: All main branches are protected and require code review before merging.
For discussions, questions, or collaboration:
We're excited to work together and improve the Sherab platform with your help!