Skip to content

Commit

Permalink
chore: use correct links inside README (#82)
Browse files Browse the repository at this point in the history
* [docs] adding new github project issue template

* chore: use correct links inside README

---------

Co-authored-by: Volodymyr Chekyrta <[email protected]>
Co-authored-by: Marco Morales <[email protected]>
  • Loading branch information
3 people authored Nov 5, 2023
1 parent 166a1ee commit 2e7ead1
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/roadmap-entry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Roadmap project entry
about: Add roadmap entry to the project
title: '[Mobile] [Android] Roadmap project name'
labels: ''
assignees: ''

---

### Goal
Describe the goal for this project

**Slack:** #wg-product-mobile
**Requirement Definition:** add Confluence project page link (or external public documentation)
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ Modern vision of the mobile application for the Open EdX platform from Raccoon G
[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-android.git

2. Open Android Studio and choose Open an Existing Android Studio Project.

3. Choose ``educationx-app-android``.
3. Choose ``openedx-app-android``.

4. Configure the [config.yaml](config.yaml) with URLs and OAuth credentials for your Open edX instance.

Expand All @@ -20,11 +21,13 @@ Modern vision of the mobile application for the Open EdX platform from Raccoon G
6. Click the **Run** button.

## API plugin

This project uses custom APIs to improve performance and reduce the number of requests to the server.

You can find the plugin with the API and installation guide [here](https://github.com/raccoongang/mobile-api-extensions).

## 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-android/blob/main/LICENSE) file for details.
Please see [LICENSE](https://github.com/openedx/openedx-app-android/blob/main/LICENSE) file for details.

0 comments on commit 2e7ead1

Please sign in to comment.