Skip to content

Commit

Permalink
GITBOOK-866: Form service
Browse files Browse the repository at this point in the history
  • Loading branch information
vinukumar-vs authored and gitbook-bot committed Aug 9, 2023
1 parent 1716674 commit 0a128ec
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 19 deletions.
9 changes: 6 additions & 3 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,13 +133,16 @@
* [Sunbird-ED Architecture](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-diagram.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-diagram.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.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)
Expand Down
File renamed without changes.
2 changes: 2 additions & 0 deletions use-1/source-code/workflows/form-service/apis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# API's

2 changes: 2 additions & 0 deletions use-1/source-code/workflows/form-service/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Architecture

2 changes: 2 additions & 0 deletions use-1/source-code/workflows/form-service/data-model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Data model

Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ description: >-

## Architecture

<figure><img src="../../../../.gitbook/assets/ed5e8b16-36e7-4738-baa6-3118cb5c6f2c.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/ed5e8b16-36e7-4738-baa6-3118cb5c6f2c.png" alt=""><figcaption></figcaption></figure>

## [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.

<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-04 at 1.18.12 AM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Screenshot 2023-08-04 at 1.18.12 AM.png" alt=""><figcaption></figcaption></figure>

\
All following primary folders are highlighted in the above screenshot
Expand All @@ -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

Expand All @@ -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.

<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-04 at 2.59.34 PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Screenshot 2023-08-04 at 2.59.34 PM.png" alt=""><figcaption></figcaption></figure>

* [home](https://sunbird-ed.github.io/docs/mobile/modules/HomePageModule.html)
* [qrcoderesult](https://sunbird-ed.github.io/docs/mobile/modules/QrcoderesultPageModule.html)
Expand Down Expand Up @@ -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.

<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-06 at 2.14.42 AM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Screenshot 2023-08-06 at 2.14.42 AM.png" alt=""><figcaption></figcaption></figure>

### 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)

Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ git

## Architecture

<figure><img src="../../../../.gitbook/assets/image (17).png" alt=""><figcaption><p>Sunbird ED Portal Architecture</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (17).png" alt=""><figcaption><p>Sunbird ED Portal Architecture</p></figcaption></figure>

## Sunbird ED Portal&#x20;

Expand All @@ -25,15 +25,15 @@ The Sunbird ED portal is divided into two folders&#x20;

**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.&#x20;

<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-09 at 10.56.12 AM.png" alt=""><figcaption><p>SUnbird Portal UI Architecture</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Screenshot 2023-08-09 at 10.56.12 AM.png" alt=""><figcaption><p>SUnbird Portal UI Architecture</p></figcaption></figure>



Expand Down Expand Up @@ -69,7 +69,7 @@ In the portal, lots of UI capabilities are generalised in terms of [formConfig](

## Front-End Libraries

<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-08 at 2.32.52 PM.png" alt=""><figcaption><p>Frontend libraries</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Screenshot 2023-08-08 at 2.32.52 PM.png" alt=""><figcaption><p>Frontend libraries</p></figcaption></figure>

The Purpose of all the libraries is to make the UI more consistent across all the clients who are using this library.

Expand All @@ -88,15 +88,15 @@ The Purpose of all the libraries is to make the UI more consistent across all th

## Sunbird Portal API Servcies&#x20;

![](../../../../.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.&#x20;

It leverages a keyCloakHelper file to handle login and logout functionalities while adopting token-based session storage to manage user sessions effectively.&#x20;

Additionally, the interface integrates multiple API middleware functions to accomplish tasks such as token verification, API whitelisting, and customizing request headers as needed.

<figure><img src="../../../../.gitbook/assets/image (25).png" alt=""><figcaption><p>API Layer Architecture</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (25).png" alt=""><figcaption><p>API Layer Architecture</p></figcaption></figure>



Expand Down Expand Up @@ -132,7 +132,7 @@ It contains the [envHelperFile](https://github.com/Sunbird-Ed/SunbirdEd-portal/b

## **Dependent Sunbird BB\`s**

<figure><img src="../../../../.gitbook/assets/image (4) (1).png" alt=""><figcaption><p>Dependent Sunbird BB`s Architecture</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (4) (1).png" alt=""><figcaption><p>Dependent Sunbird BB`s Architecture</p></figcaption></figure>

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

Expand Down

0 comments on commit 0a128ec

Please sign in to comment.