diff --git a/SUMMARY.md b/SUMMARY.md index 8e6fc52..c7b3b61 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -132,14 +132,14 @@ * [Source Code](use-1/source-code/README.md) * [Sunbird-ED Architecture](use-1/source-code/sunbird-ed-architecture.md) * [Developer Guide](use-1/source-code/workflows/README.md) - * [Mobile - Component Diagrams](use-1/source-code/workflows/mobile-component-diagrams.md) - * [Untitled](use-1/source-code/workflows/mobile-component-diagrams/untitled.md) - * [Portal - Component Diagrams](use-1/source-code/workflows/portal-component-diagrams.md) - * [Form service](use-1/source-code/workflows/form-service.md) + * [Portal](use-1/source-code/workflows/portal/README.md) + * [Component Diagram](use-1/source-code/workflows/portal/component-diagram.md) * [Mobile](use-1/source-code/workflows/mobile/README.md) + * [Component Diagram](use-1/source-code/workflows/mobile/component-diagram.md) * [sunbird-mobile-sdk](use-1/source-code/workflows/mobile/sunbird-mobile-sdk.md) * [Sunbird-mobile-app plugins](development-resources/misc-pages/sunbird-mobile-app-plugins.md) * [Configurations to setup mobile app](use-1/source-code/workflows/mobile/configurations-to-setup-mobile-app.md) + * [Form service](use-1/source-code/workflows/form-service.md) * [Reference Apps](use-1/source-code/reference-apps.md) * [Platform](use-1/source-code/platform.md) * [Install Locally](use-1/install-locally/README.md) diff --git a/use-1/source-code/workflows/mobile-component-diagrams/untitled.md b/use-1/source-code/workflows/mobile-component-diagrams/untitled.md deleted file mode 100644 index 5094080..0000000 --- a/use-1/source-code/workflows/mobile-component-diagrams/untitled.md +++ /dev/null @@ -1,2 +0,0 @@ -# Untitled - diff --git a/use-1/source-code/workflows/mobile-component-diagrams.md b/use-1/source-code/workflows/mobile/component-diagram.md similarity index 85% rename from use-1/source-code/workflows/mobile-component-diagrams.md rename to use-1/source-code/workflows/mobile/component-diagram.md index 24662ad..c251cd9 100644 --- a/use-1/source-code/workflows/mobile-component-diagrams.md +++ b/use-1/source-code/workflows/mobile/component-diagram.md @@ -5,19 +5,19 @@ description: >- Sunbird can be accessed. --- -# Mobile - Component Diagrams +# Component Diagram {% embed url="https://github.com/Sunbird-Ed/SunbirdEd-mobile-app/tree/master" %} ## Architecture -
+
## [Source Code](https://github.com/Sunbird-Ed/SunbirdEd-mobile-app/tree/master) Sunbird Mobiles app follows a basic angular / Ionic code structure. The top level of the workspace contains workspace-wide configuration files, configuration files for the application, and test files. -
+
\ All following primary folders are highlighted in the above screenshot @@ -32,7 +32,7 @@ All following primary folders are highlighted in the above screenshot **plugins** folder contains all the plugins which provide JavaScript interface to native components (Android/ Ios)required by Sunbird Mobile App. They allow the app to use native device capabilities beyond what is available to pure web components. -[List of plugins used in the Sunbird Mobile app](../../../development-resources/misc-pages/sunbird-mobile-app-plugins.md) +[List of plugins used in the Sunbird Mobile app](../../../../development-resources/misc-pages/sunbird-mobile-app-plugins.md) ### app @@ -42,7 +42,7 @@ This folder contains all the modules and components. It contains the Sunbird Mob As Modules are a great way to organize an application and extend it with capabilities from external libraries so, in the Sunbird-mobile-app, each functionality/page is configured as a Module. Some key modules are given in the below diagram. -
+
* [home](https://sunbird-ed.github.io/docs/mobile/modules/HomePageModule.html) * [qrcoderesult](https://sunbird-ed.github.io/docs/mobile/modules/QrcoderesultPageModule.html) @@ -98,18 +98,18 @@ This folder contains classes with the @injectible decorator. This decorator tell sunbird-mobile-sdk is the heart of Sunbird-mobile-app which contains all the business logic starting from API access to offline data management. -
+
### Configurations required to setup Sunbird-mobile-app These are the set of files required to set up Sunbird-mobile-app -* [sunbird.properties](mobile/configurations-to-setup-mobile-app.md#1.-sunbird.properties) -* [google-service.json](mobile/configurations-to-setup-mobile-app.md#2.-google-service.json) +* [sunbird.properties](configurations-to-setup-mobile-app.md#1.-sunbird.properties) +* [google-service.json](configurations-to-setup-mobile-app.md#2.-google-service.json) ### Forms required to initialize Sunbird-mobile-app The Form Configurations are a set of predefined forms that enable users to easily modify the UI without changing anything in the source code. Also, it allows users to quickly update any type of app attribute even if the app is already available in Play Store/app store without any app update. -[List of forms available in Sunbird-Mobile-app](../../../development-resources/misc-pages/mobile-form-configurations.md) +[List of forms available in Sunbird-Mobile-app](../../../../development-resources/misc-pages/mobile-form-configurations.md) diff --git a/use-1/source-code/workflows/portal/README.md b/use-1/source-code/workflows/portal/README.md new file mode 100644 index 0000000..419fd2f --- /dev/null +++ b/use-1/source-code/workflows/portal/README.md @@ -0,0 +1,2 @@ +# Portal + diff --git a/use-1/source-code/workflows/portal-component-diagrams.md b/use-1/source-code/workflows/portal/component-diagram.md similarity index 91% rename from use-1/source-code/workflows/portal-component-diagrams.md rename to use-1/source-code/workflows/portal/component-diagram.md index 39ea65a..064d04f 100644 --- a/use-1/source-code/workflows/portal-component-diagrams.md +++ b/use-1/source-code/workflows/portal/component-diagram.md @@ -5,7 +5,7 @@ description: >- accessed. --- -# Portal - Component Diagrams +# Component Diagram ## GitHub Repository: @@ -15,7 +15,7 @@ git ## Architecture -

Sunbird ED Portal Architecture

+

Sunbird ED Portal Architecture

## Sunbird ED Portal @@ -25,15 +25,15 @@ The Sunbird ED portal is divided into two folders **Client** : Contains the Forntend code base which used Angular framework for client-side -![](<../../../.gitbook/assets/image (22).png>)![](<../../../.gitbook/assets/image (23).png>) +![](<../../../../.gitbook/assets/image (22).png>)![](<../../../../.gitbook/assets/image (23).png>) ## **Sunbird Portal UI** -![](<../../../.gitbook/assets/image (2).png>)![](<../../../.gitbook/assets/image (3).png>) +![](<../../../../.gitbook/assets/image (2).png>)![](<../../../../.gitbook/assets/image (3).png>) [**Client Folder**](https://github.com/Sunbird-Ed/SunbirdEd-portal/tree/6.0.0/src/app/client) includes the client source code for the Angular application. This folder includes various components, modules, services, styles, and other assets necessary to build the front end of the application. -

SUnbird Portal UI Architecture

+

SUnbird Portal UI Architecture

@@ -69,7 +69,7 @@ In the portal, lots of UI capabilities are generalised in terms of [formConfig]( ## Front-End Libraries -

Frontend libraries

+

Frontend libraries

The Purpose of all the libraries is to make the UI more consistent across all the clients who are using this library. @@ -88,7 +88,7 @@ The Purpose of all the libraries is to make the UI more consistent across all th ## Sunbird Portal API Servcies -![](../../../.gitbook/assets/image.png)![](<../../../.gitbook/assets/image (1).png>) +![](../../../../.gitbook/assets/image.png)![](<../../../../.gitbook/assets/image (1).png>) [**App Folder**](https://github.com/Sunbird-Ed/SunbirdEd-portal/tree/6.0.0/src/app)(without client) Includes backend API interface which is used Node.js framework. @@ -96,7 +96,7 @@ It leverages a keyCloakHelper file to handle login and logout functionalities wh Additionally, the interface integrates multiple API middleware functions to accomplish tasks such as token verification, API whitelisting, and customizing request headers as needed. -

API Layer Architecture

+

API Layer Architecture

@@ -132,7 +132,7 @@ It contains the [envHelperFile](https://github.com/Sunbird-Ed/SunbirdEd-portal/b ## **Dependent Sunbird BB\`s** -

Dependent Sunbird BB`s Architecture

+

Dependent Sunbird BB`s Architecture

Lots of front-end Libraries and services we are leveraging from the other building blocks