diff --git a/.gitbook/assets/Screenshot 2023-08-09 at 2.18.27 PM.png b/.gitbook/assets/Screenshot 2023-08-09 at 2.18.27 PM.png new file mode 100644 index 0000000..ae2a7d4 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-08-09 at 2.18.27 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-08-09 at 3.07.34 PM.png b/.gitbook/assets/Screenshot 2023-08-09 at 3.07.34 PM.png new file mode 100644 index 0000000..6849b8e Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-08-09 at 3.07.34 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-08-09 at 3.11.47 PM.png b/.gitbook/assets/Screenshot 2023-08-09 at 3.11.47 PM.png new file mode 100644 index 0000000..f6f1b8f Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-08-09 at 3.11.47 PM.png differ diff --git a/.gitbook/assets/image (27).png b/.gitbook/assets/image (27).png new file mode 100644 index 0000000..bc178f1 Binary files /dev/null and b/.gitbook/assets/image (27).png differ diff --git a/SUMMARY.md b/SUMMARY.md index aa4c7ba..62dc0aa 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -126,40 +126,40 @@ ## Contribute -* [Extend / Contribute to Sunbird](contribute/extend-contribute-to-sunbird.md) -* [System Requirements](contribute/system-requirements/README.md) - * [Learning Apps](contribute/system-requirements/learning-apps.md) -* [Source Code](contribute/source-code/README.md) - * [Architecture - Component Diagram](contribute/source-code/architecture-component-diagram.md) - * [Developer Guide](contribute/source-code/workflows/README.md) - * [Portal](contribute/source-code/workflows/portal/README.md) - * [Component Diagram](contribute/source-code/workflows/portal/component-diagram.md) - * [Mobile](contribute/source-code/workflows/mobile/README.md) - * [Component Diagram](contribute/source-code/workflows/mobile/component-diagram.md) - * [sunbird-mobile-sdk](contribute/source-code/workflows/mobile/sunbird-mobile-sdk.md) - * [Sunbird-mobile-app plugins](contribute/source-code/workflows/mobile/sunbird-mobile-app-plugins.md) - * [Configurations to setup mobile app](contribute/source-code/workflows/mobile/configurations-to-setup-mobile-app.md) - * [Form service](contribute/source-code/workflows/form-service/README.md) - * [Architecture](contribute/source-code/workflows/form-service/architecture.md) - * [Data model](contribute/source-code/workflows/form-service/data-model.md) - * [API's](contribute/source-code/workflows/form-service/apis.md) - * [Reference Apps](contribute/source-code/reference-apps.md) - * [Platform](contribute/source-code/platform.md) -* [Install Locally](contribute/install-locally/README.md) - * [SunbirdED Mobile](contribute/install-locally/sunbirded-mobile.md) - * [SunbirdED Portal](contribute/install-locally/sunbirded-portal.md) -* [Configuration](contribute/configuration/README.md) - * [SunbirdEd Portal](contribute/configuration/sunbirded-portal.md) - * [Sunbird Mobile](contribute/configuration/sunbird-mobile.md) -* [Independent Libraries](contribute/independent-libraries/README.md) - * [Common Consumption Components](contribute/independent-libraries/common-consumption-components.md) - * [SunbirdEd Forms](contribute/independent-libraries/sunbirded-forms.md) - * [Sunbird Client Services](contribute/independent-libraries/sunbird-client-services.md) - * [Sunbird Styles](contribute/independent-libraries/sunbird-styles.md) - * [Sunbird Themes](contribute/independent-libraries/sunbird-themes.md) - * [Sunbird Tag Manager](contribute/independent-libraries/sunbird-tag-manager.md) -* [Issue tracker/ Create Issue](contribute/issue-tracker.md) -* [Contribute to ED](contribute/contribute-to-ed.md) +* [Extend / Contribute to Sunbird](use-1/extend-contribute-to-sunbird.md) +* [System Requirements](use-1/system-requirements/README.md) + * [Learning Apps](use-1/system-requirements/learning-apps.md) +* [Source Code](use-1/source-code/README.md) + * [Architecture - Component Diagram](use-1/source-code/sunbird-ed-architecture.md) + * [Developer Guide](use-1/source-code/workflows/README.md) + * [Portal](use-1/source-code/workflows/portal/README.md) + * [Component Diagram](use-1/source-code/workflows/portal-component-diagrams.md) + * [Mobile](use-1/source-code/workflows/mobile/README.md) + * [Component Diagram](use-1/source-code/workflows/mobile-component-diagrams.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/README.md) + * [Architecture](use-1/source-code/workflows/form-service/architecture.md) + * [Data model](use-1/source-code/workflows/form-service/data-model.md) + * [API's](use-1/source-code/workflows/form-service/apis.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) + * [SunbirdED Mobile](use-1/install-locally/sunbirded-mobile.md) + * [SunbirdED Portal](use-1/install-locally/sunbirded-portal.md) +* [Configuration](use-1/configuration/README.md) + * [SunbirdEd Portal](use-1/configuration/sunbirded-portal.md) + * [Sunbird Mobile](use-1/configuration/sunbird-mobile.md) +* [Independent Libraries](use-1/independent-libraries/README.md) + * [Common Consumption Components](use-1/independent-libraries/common-consumption-components.md) + * [SunbirdEd Forms](use-1/independent-libraries/sunbirded-forms.md) + * [Sunbird Client Services](use-1/independent-libraries/sunbird-client-services.md) + * [Sunbird Styles](use-1/independent-libraries/sunbird-styles.md) + * [Sunbird Themes](use-1/independent-libraries/sunbird-themes.md) + * [Sunbird Tag Manager](use-1/independent-libraries/sunbird-tag-manager.md) +* [Issue tracker/ Create Issue](use-1/issue-tracker.md) +* [Contribute to ED](use-1/contribute-to-ed.md) ## Misc diff --git a/contribute/source-code/workflows/README.md b/contribute/source-code/workflows/README.md deleted file mode 100644 index 7f043c6..0000000 --- a/contribute/source-code/workflows/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Workflows - diff --git a/contribute/source-code/workflows/form-service/README.md b/contribute/source-code/workflows/form-service/README.md deleted file mode 100644 index cbd0de0..0000000 --- a/contribute/source-code/workflows/form-service/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Form service - -## Github Repository: - -{% embed url="https://github.com/Sunbird-Ed/SunbirdEd-forms" %} diff --git a/contribute/source-code/workflows/form-service/apis.md b/contribute/source-code/workflows/form-service/apis.md deleted file mode 100644 index b535b3e..0000000 --- a/contribute/source-code/workflows/form-service/apis.md +++ /dev/null @@ -1,2 +0,0 @@ -# API's - diff --git a/contribute/source-code/workflows/form-service/architecture.md b/contribute/source-code/workflows/form-service/architecture.md deleted file mode 100644 index a2dc5cd..0000000 --- a/contribute/source-code/workflows/form-service/architecture.md +++ /dev/null @@ -1,2 +0,0 @@ -# Architecture - diff --git a/contribute/source-code/workflows/form-service/data-model.md b/contribute/source-code/workflows/form-service/data-model.md deleted file mode 100644 index 36562d2..0000000 --- a/contribute/source-code/workflows/form-service/data-model.md +++ /dev/null @@ -1,2 +0,0 @@ -# Data model - diff --git a/contribute/source-code/workflows/mobile/sunbird-mobile-app-plugins.md b/development-resources/misc-pages/sunbird-mobile-app-plugins.md similarity index 100% rename from contribute/source-code/workflows/mobile/sunbird-mobile-app-plugins.md rename to development-resources/misc-pages/sunbird-mobile-app-plugins.md diff --git a/learn/technical-architecture/technical-architecture-diagram.md b/learn/technical-architecture/technical-architecture-diagram.md index 18d6f3e..fcee3df 100644 --- a/learn/technical-architecture/technical-architecture-diagram.md +++ b/learn/technical-architecture/technical-architecture-diagram.md @@ -6,4 +6,4 @@ ## **Component view diagram** -[architecture-component-diagram.md](../../contribute/source-code/architecture-component-diagram.md "mention") +[sunbird-ed-architecture.md](../../use-1/source-code/sunbird-ed-architecture.md "mention") diff --git a/contribute/configuration/README.md b/use-1/configuration/README.md similarity index 100% rename from contribute/configuration/README.md rename to use-1/configuration/README.md diff --git a/contribute/configuration/sunbird-mobile.md b/use-1/configuration/sunbird-mobile.md similarity index 100% rename from contribute/configuration/sunbird-mobile.md rename to use-1/configuration/sunbird-mobile.md diff --git a/contribute/configuration/sunbirded-portal.md b/use-1/configuration/sunbirded-portal.md similarity index 100% rename from contribute/configuration/sunbirded-portal.md rename to use-1/configuration/sunbirded-portal.md diff --git a/contribute/contribute-to-ed.md b/use-1/contribute-to-ed.md similarity index 100% rename from contribute/contribute-to-ed.md rename to use-1/contribute-to-ed.md diff --git a/contribute/extend-contribute-to-sunbird.md b/use-1/extend-contribute-to-sunbird.md similarity index 82% rename from contribute/extend-contribute-to-sunbird.md rename to use-1/extend-contribute-to-sunbird.md index bb57bb7..c3037ab 100644 --- a/contribute/extend-contribute-to-sunbird.md +++ b/use-1/extend-contribute-to-sunbird.md @@ -2,7 +2,7 @@ **Contribution process** -****[**https://sunbird.gitbook.io/sunbird-community-practices/VJZlxBFjATn5Y97QSiJB/**](https://sunbird.gitbook.io/sunbird-community-practices/VJZlxBFjATn5Y97QSiJB/)**** +[**https://sunbird.gitbook.io/sunbird-community-practices/VJZlxBFjATn5Y97QSiJB/**](https://sunbird.gitbook.io/sunbird-community-practices/VJZlxBFjATn5Y97QSiJB/) **Priority definition** diff --git a/contribute/independent-libraries/README.md b/use-1/independent-libraries/README.md similarity index 100% rename from contribute/independent-libraries/README.md rename to use-1/independent-libraries/README.md diff --git a/contribute/independent-libraries/common-consumption-components.md b/use-1/independent-libraries/common-consumption-components.md similarity index 100% rename from contribute/independent-libraries/common-consumption-components.md rename to use-1/independent-libraries/common-consumption-components.md diff --git a/contribute/independent-libraries/sunbird-client-services.md b/use-1/independent-libraries/sunbird-client-services.md similarity index 100% rename from contribute/independent-libraries/sunbird-client-services.md rename to use-1/independent-libraries/sunbird-client-services.md diff --git a/contribute/independent-libraries/sunbird-styles.md b/use-1/independent-libraries/sunbird-styles.md similarity index 100% rename from contribute/independent-libraries/sunbird-styles.md rename to use-1/independent-libraries/sunbird-styles.md diff --git a/contribute/independent-libraries/sunbird-tag-manager.md b/use-1/independent-libraries/sunbird-tag-manager.md similarity index 100% rename from contribute/independent-libraries/sunbird-tag-manager.md rename to use-1/independent-libraries/sunbird-tag-manager.md diff --git a/contribute/independent-libraries/sunbird-themes.md b/use-1/independent-libraries/sunbird-themes.md similarity index 100% rename from contribute/independent-libraries/sunbird-themes.md rename to use-1/independent-libraries/sunbird-themes.md diff --git a/contribute/independent-libraries/sunbirded-forms.md b/use-1/independent-libraries/sunbirded-forms.md similarity index 100% rename from contribute/independent-libraries/sunbirded-forms.md rename to use-1/independent-libraries/sunbirded-forms.md diff --git a/contribute/install-locally/README.md b/use-1/install-locally/README.md similarity index 100% rename from contribute/install-locally/README.md rename to use-1/install-locally/README.md diff --git a/contribute/install-locally/sunbirded-mobile.md b/use-1/install-locally/sunbirded-mobile.md similarity index 100% rename from contribute/install-locally/sunbirded-mobile.md rename to use-1/install-locally/sunbirded-mobile.md diff --git a/contribute/install-locally/sunbirded-portal.md b/use-1/install-locally/sunbirded-portal.md similarity index 100% rename from contribute/install-locally/sunbirded-portal.md rename to use-1/install-locally/sunbirded-portal.md diff --git a/contribute/issue-tracker.md b/use-1/issue-tracker.md similarity index 87% rename from contribute/issue-tracker.md rename to use-1/issue-tracker.md index edb91e2..f28a9a4 100644 --- a/contribute/issue-tracker.md +++ b/use-1/issue-tracker.md @@ -1,3 +1,3 @@ -# Issue tracker +# Issue tracker/ Create Issue Link to issues in Issue tracker - [Link](https://project-sunbird.atlassian.net/jira/software/c/projects/ED/issues/?jql=project%20%3D%20%22ED%22%20AND%20type%20in%20standardIssueTypes\(\)%20ORDER%20BY%20created%20DESC) diff --git a/contribute/source-code/README.md b/use-1/source-code/README.md similarity index 100% rename from contribute/source-code/README.md rename to use-1/source-code/README.md diff --git a/contribute/source-code/platform.md b/use-1/source-code/platform.md similarity index 100% rename from contribute/source-code/platform.md rename to use-1/source-code/platform.md diff --git a/contribute/source-code/reference-apps.md b/use-1/source-code/reference-apps.md similarity index 100% rename from contribute/source-code/reference-apps.md rename to use-1/source-code/reference-apps.md diff --git a/contribute/source-code/architecture-component-diagram.md b/use-1/source-code/sunbird-ed-architecture.md similarity index 98% rename from contribute/source-code/architecture-component-diagram.md rename to use-1/source-code/sunbird-ed-architecture.md index 6a834a5..da2e18a 100644 --- a/contribute/source-code/architecture-component-diagram.md +++ b/use-1/source-code/sunbird-ed-architecture.md @@ -1,4 +1,4 @@ -# Sunbird-ED Architecture +# Architecture - Component Diagram ## Architecuture diff --git a/use-1/source-code/workflows/README.md b/use-1/source-code/workflows/README.md new file mode 100644 index 0000000..434a513 --- /dev/null +++ b/use-1/source-code/workflows/README.md @@ -0,0 +1,2 @@ +# Developer Guide + diff --git a/use-1/source-code/workflows/form-service/README.md b/use-1/source-code/workflows/form-service/README.md new file mode 100644 index 0000000..677b458 --- /dev/null +++ b/use-1/source-code/workflows/form-service/README.md @@ -0,0 +1,6 @@ +# Form service + +{% embed url="https://github.com/project-sunbird/sunbird-ext-framework" %} + + + diff --git a/use-1/source-code/workflows/form-service/apis.md b/use-1/source-code/workflows/form-service/apis.md new file mode 100644 index 0000000..6e567ce --- /dev/null +++ b/use-1/source-code/workflows/form-service/apis.md @@ -0,0 +1,26 @@ +--- +description: Sample API Reference for Form Service Used in ED Portal +--- + +# API's + + + +## Sunbird-Forms + +This service is owned by Sunbird-ED Building Block. The CRUD API's are documented as part of the below API collection. + +What properties can be used as part of forum create & the details has updated in the below document itself. + +{% embed url="https://documenter.getpostman.com/view/25186239/2s93Y2TNAw" %} + +## **Sunbird ED Portal Postman Forms Config Documentation** + +This Postman Forms collection details about + +* Configuring forms for the functional features used in the portal +* The documentation of usage of each form API's in the portal. +* Functional form configs with Sample Create and Read API's. +* Mandatory and Non-mandatory forms with impact. + +{% embed url="https://documenter.getpostman.com/view/25186239/2s946pXoZ2" %} diff --git a/use-1/source-code/workflows/form-service/architecture.md b/use-1/source-code/workflows/form-service/architecture.md new file mode 100644 index 0000000..f3265cb --- /dev/null +++ b/use-1/source-code/workflows/form-service/architecture.md @@ -0,0 +1,44 @@ +# Architecture + +

Form Service Architecture

+ +## From Service + +It's an extensible framework library to create a server side API endpoint. + +### [EXT Framework Server](https://github.com/project-sunbird/sunbird-ext-framework/blob/master/server/README.md#plugin-lifecycle) + +During this phase, the framework tries to read the manifest.ts file under the plugin's home directory. + +When it finds the manifest.ts file, it will register the plugin in the "plugin registry" and update the status of the plugin as REGISTERED. + +The framework tries to locate if any schema files are defined in the manifest.ts file. If the plugin has not defined any schema file, the framework would skip this step. + +If there are schema files, then it would try to create a schema(tables/index) on the corresponding database provided based on the schema definition + +### [Framework API /Route](https://github.com/project-sunbird/sunbird-ext-framework/blob/master/demo/plugins/FormService/server/routes.ts) + +During this phase, the framework tries to find `routes.ts` files under the plugin home directory. If the file is not found, the plugin fails to load. + +The file should export a class named `Router`. The framework registers the routes(endpoint) defined for the plugin with the "prefix" defined in the `manifest.ts` file. + +### [Request Validator](https://github.com/project-sunbird/sunbird-ext-framework/blob/master/demo/plugins/FormService/server/RequestValidator/index.ts) + +During this phase, the framework will validate the request body that is requested by the client app. If the request doesn't have mandatory data or valid input it will throw the error in response. + +### [Server Method](https://github.com/project-sunbird/sunbird-ext-framework/blob/master/demo/plugins/FormService/server/server.ts) + +During this phase, the method retrieves data from a Cassandra database based on the provided query parameters. + +It tries to find a matching record by gradually relaxing the constraints on the properties. Once a record is found or all attempts are exhausted, the retrieved data is processed and sent back as a response. + + + + + + + + + +### + diff --git a/use-1/source-code/workflows/form-service/data-model.md b/use-1/source-code/workflows/form-service/data-model.md new file mode 100644 index 0000000..78d2f89 --- /dev/null +++ b/use-1/source-code/workflows/form-service/data-model.md @@ -0,0 +1,24 @@ +--- +description: Cassandra database used in Form service +--- + +# Data model + + + +| Column Name | Data Type | Description | Sample Data | +| ------------------ | --------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| id | string | Represents an API uniquely | api.form.create | +| ver | string | Represents the version of the API which was used | 1.0 | +| ts | integer | Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH | 2023-04-13T11:04:52.333Z | +| params | object | |

{

"resmsgid": "bb6c9650-5a04-44e8-9077-452ef7aa5cdf",

"msgid": "6f64bd31-cf55-4f80-9f13-d19a799fe6fa",

"status": "successful"

}

| +| msgid | string | Represents the unique ID of the message being sent | 6f64bd31-cf55-4f80-9f13-d19a799fe6fa | +| did | string | Represents the device UUID from which API is called | bb6c9650-5a04-44e8-9077-452ef7aa5cdf | +| type\* | varchar | Represents the type of form being created | content, user, forum, app, program-dashboard, config | +| subtype\* | varchar | Represents the sub-category of form being created | course, collection, textbook, resource, login | +| action\* | varchar | Represents the user action on the form | ilter, create, get, save, review , search | +| component\* | varchar | Represents the consumption platform for the form | portal, mobile | +| root\_org | varchar | Represents the form accesabilty to all (\*) or specific | \*, 123213232332323 | +| framework | varchar | Represents the form accesabilty to all (\*) or specific | \*, 121324324274724 | +| created\_on | timestamp | created time | 2023-04-13T11:08:21.260Z | +| last\_modified\_on | timestamp | modified time | 2023-04-13T12:35:52.143Z | diff --git a/contribute/source-code/workflows/mobile/component-diagram.md b/use-1/source-code/workflows/mobile-component-diagrams.md similarity index 85% rename from contribute/source-code/workflows/mobile/component-diagram.md rename to use-1/source-code/workflows/mobile-component-diagrams.md index 5b147ed..d616ceb 100644 --- a/contribute/source-code/workflows/mobile/component-diagram.md +++ b/use-1/source-code/workflows/mobile-component-diagrams.md @@ -11,13 +11,13 @@ description: >- ## 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](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](configurations-to-setup-mobile-app.md#1.-sunbird.properties) -* [google-service.json](configurations-to-setup-mobile-app.md#2.-google-service.json) +* [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) ### 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/contribute/source-code/workflows/mobile/README.md b/use-1/source-code/workflows/mobile/README.md similarity index 100% rename from contribute/source-code/workflows/mobile/README.md rename to use-1/source-code/workflows/mobile/README.md diff --git a/contribute/source-code/workflows/mobile/configurations-to-setup-mobile-app.md b/use-1/source-code/workflows/mobile/configurations-to-setup-mobile-app.md similarity index 100% rename from contribute/source-code/workflows/mobile/configurations-to-setup-mobile-app.md rename to use-1/source-code/workflows/mobile/configurations-to-setup-mobile-app.md diff --git a/contribute/source-code/workflows/mobile/sunbird-mobile-sdk.md b/use-1/source-code/workflows/mobile/sunbird-mobile-sdk.md similarity index 100% rename from contribute/source-code/workflows/mobile/sunbird-mobile-sdk.md rename to use-1/source-code/workflows/mobile/sunbird-mobile-sdk.md diff --git a/contribute/source-code/workflows/portal/component-diagram.md b/use-1/source-code/workflows/portal-component-diagrams.md similarity index 91% rename from contribute/source-code/workflows/portal/component-diagram.md rename to use-1/source-code/workflows/portal-component-diagrams.md index 064d04f..0291036 100644 --- a/contribute/source-code/workflows/portal/component-diagram.md +++ b/use-1/source-code/workflows/portal-component-diagrams.md @@ -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 diff --git a/contribute/source-code/workflows/portal/README.md b/use-1/source-code/workflows/portal/README.md similarity index 100% rename from contribute/source-code/workflows/portal/README.md rename to use-1/source-code/workflows/portal/README.md diff --git a/contribute/system-requirements/README.md b/use-1/system-requirements/README.md similarity index 100% rename from contribute/system-requirements/README.md rename to use-1/system-requirements/README.md diff --git a/contribute/system-requirements/learning-apps.md b/use-1/system-requirements/learning-apps.md similarity index 100% rename from contribute/system-requirements/learning-apps.md rename to use-1/system-requirements/learning-apps.md