Skip to content

Commit 45d9d6a

Browse files
Update README.md
1 parent cc67ac7 commit 45d9d6a

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
1-
# new-edx-app-android
1+
2+
# NewEdX Android
3+
4+
Modern vision of the mobile application for Open EdX from Raccoon Gang.
5+
6+
## Building
7+
1. Check out the source code:
8+
9+
git clone https://github.com/raccoongang/new-edx-app-android.git
10+
11+
2. Open Android Studio and choose Open an Existing Android Studio Project.
12+
13+
3. Choose ``new-edx-app-android``.
14+
15+
4. Configure the [``config.yaml`` file](https://github.com/raccoongang/new-edx-app-android/blob/main/config.yaml) with URLs and OAuth credentials for your Open edX instance.
16+
17+
5. Select the build variant ``develop``, ``stage``, or ``prod``.
18+
19+
6. Click the **Run** button.
20+
21+
## Roadmap
22+
Please feel welcome to develop any of the suggested features below and submit a pull request.
23+
24+
- Migrate to the new APIs
25+
- Recent searches
26+
- Migrate to the Olive and JWT token
27+
- UnAuth User mode
28+
- Prerequisite course
29+
- Prerequisite sections
30+
- Scorm XBlocks
31+
- Native Programs
32+
- New discovery (catalog)
33+
- E-Commerce
34+
35+
## License
36+
The code in this repository is licensed under the AGPL v3 license unless otherwise noted.
37+
38+
Please see [LICENSE](https://github.com/raccoongang/new-edx-app-android/blob/main/LICENSE) file for details.

0 commit comments

Comments
 (0)