Skip to content

Commit

Permalink
GITBOOK-717: Build properties mandatory and optional changes
Browse files Browse the repository at this point in the history
  • Loading branch information
surendrasinghs authored and gitbook-bot committed Mar 6, 2023
1 parent 1a693b2 commit 7dc6594
Show file tree
Hide file tree
Showing 17 changed files with 336 additions and 192 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed .gitbook/assets/image (14) (1) (1) (1) (1).png
Binary file not shown.
Binary file not shown.
43 changes: 0 additions & 43 deletions .gitbook/assets/prerequisites (1).md

This file was deleted.

4 changes: 3 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@
* [Demo of released items](use/releases/demo-of-released-items.md)
* [Telemetry](use/telemetry/README.md)
* [Trackable Collection](use/telemetry/course.md)
* [Minimal forms](use/minimal-forms.md)

## Engage

Expand Down Expand Up @@ -159,10 +160,11 @@
## Development Resources

* [Misc Pages](development-resources/misc-pages/README.md)
* [Configurations to setup mobile app](development-resources/misc-pages/configurations-to-setup-mobile-app.md)
* [Content Indexing Flow](development-resources/misc-pages/content-indexing-flow.md)
* [What are multiple databases used for](development-resources/misc-pages/what-are-multiple-databases-used-for.md)
* [Course completion, reports and certificate issue](development-resources/misc-pages/course-completion-reports-and-certificate-issue.md)
* [How to access Flink UI](development-resources/misc-pages/how-to-access-flink-ui.md)
* [What are all the flink jobs for](development-resources/misc-pages/what-are-all-the-flink-jobs-for.md)
* [How does data flow into Druid](development-resources/misc-pages/how-does-data-flow-into-druid.md)
* [Minimal build properties](development-resources/misc-pages/minimal-build-properties.md)
* [Configurations to setup mobile app](development-resources/misc-pages/configurations-to-setup-mobile-app.md)
42 changes: 0 additions & 42 deletions development-resources/misc-pages/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,2 @@
---
description: Minimal build properties
---

# Misc Pages

To ensure the sunbird is easily adopted by different adapters, it is important to understand the minimal build properties required. In this article, we will delve into these requirements and explore the key factors that play a role in ensuring a seamless integration of sunbird.

\


The minimal build properties include the following,

```properties
//App specific Properties
staging_app_id = org.sunbird.app.staging
app_name = Sunbird
app_version_code = 1

// Staging environment properties.
staging_base_url = https://staging.sunbirded.org
staging_device_register_base_url= https://apistaging.ntp.net.in
staging_mobile_app_key = <app-key>
staging_mobile_app_secret = <app-secret>
staging_deeplink_base_url = staging.sunbirded.org

support_email = [email protected]

```

The sunbird.properties file contains various properties that are used to configure the app for different environments (dev, staging, and production). For the minimal properties, we are considering only a staging environment as of now.

The properties include details such as the app's ID, version code, and name. It also contains properties specific to each environment, such as the base URL, mobile app key and secret, channel ID, producer ID, deep link URLs, OAuth redirect URL, etc.



It also contains properties for Fabric keys, which are used for crash reporting and analytics in the mobile app.\


Additionally, it contains some properties for displaying specific information in the app, such as displaying framework categories in the profile, and sign-in footer cards in different tabs for teachers and students.

These properties are set to default values and these values will be replaced with actual values by the developer or dev-ops team before the app is deployed to each environment.

\
48 changes: 48 additions & 0 deletions development-resources/misc-pages/minimal-build-properties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Minimal build properties

To ensure different adapters easily adopt the sunbird, it is important to understand the minimal build properties required. In this article, we will delve into these requirements and explore the key factors that play a role in ensuring a seamless integration of sunbird.&#x20;

The mandatory build properties include the following,&#x20;

```
//App-specific Properties
staging_app_id = org.sunbird.app.staging
app_name = Sunbird
app_version_code = 1
// Staging environment properties.
staging_base_url = https://staging.sunbirded.org
staging_device_register_base_url= https://apistaging.ntp.net.in
staging_mobile_app_key = sunbird-0.1
staging_mobile_app_secret = c0MsZyjLdKYMz255KKRvP0TxVbkeNFlx
staging_deeplink_base_url = staging.sunbirded.org
// Fabric Keys
release_fabric_api_key = 4a735dc3520070ad4ea3339e4d8d2bb00efe8eaa
release_fabric_api_secret = a98a1c7293881445c6e471588c3adaaef3814c89bdf26b4c1393196162ba9e1c
support_email = [email protected]
```

Optional build properties include the following,

```
// Staging environment properties.
staging_channel_id = 505c7c48ac6dc1edc9b08f21db5a571d
staging_producer_id = staging.diksha.app
staging_merge_account_base_url= https://merge.staging.ntp.net.in
staging_deeplink_ncert_url = epathshala.nic.in
staging_deeplink_igot_url = igot.gov.in
staging_tou_base_url = https://static.preprod.ntp.net.in
staging_survey_base_url= https://google.com/
staging_projects_base_url = https://google.com
```

The sunbird.properties file contains various properties that are used to configure the app for different environments (dev, staging, and production). For the minimal properties, we are considering only a staging environment as of now.

The properties include the app's ID, version code, and name. It also contains properties specific to the staging environment, such as the base URL, mobile app key and secret, channel ID, producer ID, deep link URLs, OAuth redirect URL, etc.

It also contains properties for Fabric keys, which are used for crash reporting and analytics in the mobile app.

These properties are set to default values and will be replaced with actual values by the developer or dev-ops team before the app is deployed to each environment.
2 changes: 1 addition & 1 deletion learn/functional-capabilities/learning-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Enable learning for anyone, on any device, anywhere. Learning Apps are front-end
4. Enables contextual discovery based on user's preferences and persona.
5. Enable access for anonymous as well as registered users.

![](../../.gitbook/assets/image.png)
![](<../../.gitbook/assets/image (11).png>)

**Mobile app** Works on a range of mobile devices Android 6+, iOS 9+ and optimized app size for a variety of devices

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Allowing users to discover content based on their preferences

1. **Browsing menus & filtering as per users' preference**&#x20;

![](<../../../../.gitbook/assets/Home 1.jpg>)
![](<../../../../.gitbook/assets/WhatsApp Image 2022-04-01 at 3.20.31 PM (1) (1).jpg>)

This is where the generalisation+ personalisation really kicks in. You can configure all types of browsing and navigation experiences on Sunbird Ed. The most familiar paradigm to users is domain or framework**-**based discovery. For example&#x20;

Expand Down Expand Up @@ -33,7 +33,7 @@ This is one mode that really excites us is asking questions is the most fundamen

**4. Free text search**&#x20;

![](../../../../.gitbook/assets/Search.jpg)
![](<../../../../.gitbook/assets/Screenshot\_20220401-150135\_DIKSHA (1).jpg>)

You can allow users to discover and search for content and make them personalised. Discover enables users to get inspired and take action before searching. You can enable users to discover content for other boards, audiences, categories, etc.

Expand Down
2 changes: 1 addition & 1 deletion misc/archived/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Any Actor in the system will go through the workflow in following steps:

![](<../../.gitbook/assets/Consumption workflow.PNG>)
![](<../../.gitbook/assets/Consumption workflow (1).PNG>)

**OnBoard / Setup User** : Sunbird reference apps allow users to onboard either anonymously or as via logins. This step ensures that users really discover assets that are relevant to them. This step allows users to pull personalised recommendation from the system.

Expand Down
Loading

0 comments on commit 7dc6594

Please sign in to comment.