-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: Update README * docs: Update License URL
- Loading branch information
1 parent
d85bd9f
commit a08380e
Showing
2 changed files
with
20 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# APIs Compatibility | ||
|
||
This documentation offers guidance on a workaround for utilizing mobile APIs with earlier versions of Open edX releases. | ||
|
||
In December 2023, the [FC-0031 project](https://github.com/openedx/edx-platform/issues/33304) introduced new APIs, and the Open edX mobile apps were transitioned to utilize them. | ||
|
||
If your platform version is older than December 2023, follow the instructions below: | ||
|
||
1. Setup the [mobile-api-extensions](https://github.com/raccoongang/mobile-api-extensions) plugin to your platform. | ||
The Plugin contains extended Open edX APIs for mobile applications. | ||
2. Roll back the modifications that brought in the new APIs [3bca8bf](https://github.com/openedx/openedx-app-ios/commit/3bca8bfa994163635e1128f0404007c6d0d4761f). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,30 @@ | ||
# EducationX iOS | ||
# Open edX iOS | ||
|
||
Modern vision of the mobile application for the Open EdX platform from Raccoon Gang. | ||
Modern vision of the mobile application for the Open edX platform from Raccoon Gang. | ||
|
||
[Documentation](Documentation/Documentation.md) | ||
|
||
## Building | ||
1. Check out the source code: | ||
|
||
git clone https://github.com/raccoongang/educationx-app-ios.git | ||
git clone https://github.com/openedx/openedx-app-ios.git | ||
|
||
2. Navigate to the project folder and run ``pod install``. | ||
|
||
3. Open ``OpenEdX.xcworkspace``. | ||
|
||
4. Ensure that the ``OpenEdXDev`` or ``OpenEdXProd`` scheme is selected. | ||
4. Ensure that the ``OpenEdXDev``, ``OpenEdXStage`` or ``OpenEdXProd`` scheme is selected. | ||
|
||
5. Configure `config_settings.yaml` inside `default_config` and `config.yaml` inside sub direcroties to point to your OpenEdx configuration [Configuration Docuementation](./Documentation/CONFIGURATION_MANAGEMENT.md) | ||
5. Configure `config_settings.yaml` inside `default_config` and `config.yaml` inside sub direcroties to point to your OpenEdx configuration [Configuration Documentation](./Documentation/CONFIGURATION_MANAGEMENT.md) | ||
|
||
6. Click the **Run** button. | ||
|
||
## API plugin | ||
This project uses custom APIs to improve performance and reduce the number of requests to the server. | ||
## API | ||
This project targets on the latest Open edX release and rely on the relevant mobile APIs. | ||
|
||
You can find the plugin with the API and installation guide [here](https://github.com/raccoongang/mobile-api-extensions). | ||
If your platform version is older than December 2023, please follow the instructions to use the [API Plugin](./Documentation/APIs_Compatibility.md). | ||
|
||
## License | ||
The code in this repository is licensed under the Apache-2.0 license unless otherwise noted. | ||
|
||
Please see [LICENSE](https://github.com/raccoongang/educationx-app-ios/blob/main/LICENSE) file for details. | ||
Please see [LICENSE](https://github.com/openedx/openedx-app-ios/blob/main/LICENSE) file for details. |