Configurable Angular front end with generic forms and layouts for Sunbird RC
Please use the community repo for reporting issues & participating in discussions
This is an Angular 8 project, and you need to install the dependencies, and run the project.
-
Clone Sunbird RC UI code from here - https://github.com/Sunbird-RC/sunbird-rc-ui
-
Clone UI config files from git - https://github.com/Sunbird-RC/demo-education-registry
-
Go to into the
demo-education-registry/ui-configand copy this folder path -
Then go to into the
/sunbird-rc-ui/src/assets/configfolder and open terminal
Run blow command in the following folder path : sunbird-rc-ui/src/assets/config
ln -s (path-of-your-UI-config files folder)
Eg : ln -s Documents/Ndear/demo-education-registry/ui-config
- Add
config.jsonandhome.htmlfile on below mentioned path (config.json file will generate by dynamically once user fill up the installation form and home.html page need to construct as per user requirment)
sunbird-rc-ui/src/assets/config
- Go to root folder means sunbird-rc-ui folder
Run below commands -
yarn
npm start
- Once project run completely then you will get
http://localhost:4200url
to open an angular application in the browser.
- Copy that url( http://localhost:4200) and paste in your browser.
Fill up the all configuration details in installation page. The application needs to be configured with the appropriate fields to be able to use it.
| Fields | Info |
|---|---|
baseUrl |
Base URL for the Sunbird RC backend. Eg: https://registry.com/api |
schemaUrl |
URL to the OpenAPI schema definition. This could be a HTTP path or a path to a local file Eg: https://registry.com/api/schema.json OR /assets/schema.json |
logo |
URL to logo. This logo is displayed in the header of the UI |
project name |
Name of Application |
keycloak Configuration |
Required url, clientId and realm to initialize keycloak into application |
theme color code |
To change application theme mode |
The forms.json needs to be placed in src/assets/config. This file defines the schema for various forms used, along with the fields for each. The form rendering is based on the formly.dev library, and the forms.json is a small wrapper on top of the formly schema.
In this file forms is an array with key/value pairs. They key is the code / slug of the form which is used to access the form. Eg: if the key for a form is employee-signup that form can be accessed via /forms/employee-signup. Each form definition will have the below fields -
| Key | Value |
|---|---|
form.api |
This is the path to the API endpoints for the entity this form handles. Eg: /Employer |
form.type |
Forms can be of 2 types. It can either be a form to create a new entity Eg: Employer, or it could be a form to submit a "sub-field" eg: work experience of an employee. For the former use entity. For the latter use property:<property name> (eg: property:work_experience) |
form.formclass |
HTML Class applied to the form container |
form.title |
Title of form |
form.redirectTo |
Redirect URL on after form submit |
form.fieldsets |
List of fieldsets(multiple) for this form. At least one fieldset is needed |
form.isSignupForm |
Set true if defination is writting for signup form. |
form.langKey |
This is the name of key, which contains the all language constants strings for this form in the en-local.json file. Eg: form.json: { en-local.json: { |
fieldsets
| Key | Value |
|---|---|
fieldsets.definition |
Name of the OpenAPI "Definition" to use |
fieldsets.fields |
List of fields(multiple) to populate for this fieldset. If you wish to display all fields from the schema, you can skip defining each field, and use use "fields": ["*"] |
fields
| Key | Value |
|---|---|
fields.name |
Name of field (same as defined in defination of that schema) |
fields.custom |
boolean Name of custome field (not defined in defination of that schema) |
fields.required |
boolean |
fields.class |
Class of field |
fields.disabled |
boolean Disable the field (readonly) |
fields.children |
object Reference field of defination (same properties as fieldsets) |
fields.validation |
{ |
The layouts.json is used to define how the public and private profile pages look like. For each entity in OpenSaber backend, a layout file should be defined with the fields and the order in which they should display.
In this file layouts is an array with key/value pairs. They key is the code / slug of the layout page which is used to access the form. Eg: if the key for a layout is employee-profile that page can be accessed via /profile/employee-profile. Each layout definition will have the below fields -
| Key | Value |
|---|---|
layout.api |
URL Path of API |
layout.title |
Title of form |
layout.blocks |
Cards/Blocks (multiple) to populate in layout. |
layout.headerName |
Set Name of logged in user in header section. |
layout.subHeadername |
Set Address of logged in user in sub-header section.. |
layout.langKey |
This is the name of key, which contains the all language constants strings for this layout in the en-local.json file. Eg: layout.json: { en-local.json: { |
blocks
| Key | Value |
|---|---|
blocks.definition |
Defination of fields from JSON Schemas in schemaUrl |
blocks.title |
Title of Card/Block |
blocks.add |
boolean Enable Add Button |
blocks.addform |
<name of form from forms> Form opens on Add Button click |
blocks.edit |
boolean Enable Edit Button |
blocks.editform |
<name of form from forms> Form opens on Edit Button click |
blocks.multiple |
boolean Enable Multiple values |
blocks.fields |
Array/List of fields(multiple) to populate in fieldsets |
fields
| Key | Value |
|---|---|
fields.includes |
Array/list of Included Fields from response or [*] for all fields |
fields.excludes |
Array/list of Excluded Fields from response |
The search.json needs to be placed in src/assets/config. In this file defines the tabs, filters and result cards attribute names which are displayed on the discovery page.
In this file searches is an array with key/value pairs. Each search definition will have the below fields -
| Key | Value |
|---|---|
search.tab |
Key name of tab |
search.tabTitle |
Title of tab |
search.api |
URL Path of API |
search.activeTab |
Set active tab as a default. |
search.privateFields |
Field visibility configuration. |
filters
| Key | Value |
|---|---|
filters.key |
unique key of filter/property |
filters.title |
Title of filter |
filters.type |
Type of filter |
filters.propertyPath |
Actul path of property in your api responce |
filters.default |
Set filter as default |
filters.placeholder |
Set placeholder in the filter input box |
fields
| Key | Value |
|---|---|
fields.title |
Title of field |
fields.property |
Set property path in you api responce (eg : "address.district" ) |
fields.attest |
Set state check property key name |
fields.autocomplete |
Auto auto suggestion field
|
"body": {
"filters": {
"instituteName": {
"startsWith": "{{value}}"
},
"affiliation._State": {
"eq": "PUBLISHED"
}
},
"limit": 20,
"offset": 0
}
}
</pre>
You can find examples of config files here
To avoid CORS issues you can use proxy configuration.
Step 1
Firstly check a proxy.conf.json file in the root folder.
Step 2 Now we have to create the proxy configuration for API endpoints. So add your proxy configuration in your proxy.conf.json file as given in the below format-
"/registry/api/docs": {
"target": "https://domainname/",
"secure": false,
"changeOrigin": true,
"logLevel": "debug"
}
Definition of parameters is given below-
"/echo” is your API Path.
"target" is your domain name where your API’s are hosted.
"secure" is a boolean type parameter, if your domain has SSL then you should use true else you should use false as value.
"changeOrigin" should be true if your backend is not hosted on localhost server.
“logLevel" is used to check whether a proxy is working or not. Proxy log levels are info (the default), debug, warn, error, and silent.
Step 3:
Now finally we have to replace domain name with http://localhost:4200/ from config.json file.
And Run npm start or ng serve --proxy-config proxy.conf.json.