Commit 170aa79b authored by Matija Obreza's avatar Matija Obreza
Browse files

Docs: Updated documentation

parent 46aa25ae
......@@ -29,7 +29,7 @@ Add a container `<div>` to your HTML page and initialize the Genesys UI with the
apiUrl: 'https://api.sandbox.genesys-pgr.org', // Genesys API server
clientId: 'clientid@genesys', // Client ID
clientKey: 'changeme', // Client key
title: 'Genesys |', // HTML title prefix
title: 'Genesys:', // HTML title prefix
filter: {
institute: { code: [ 'ETH013' ] }, // Genesys data filter
},
......@@ -62,12 +62,12 @@ to *@geneesys-pgr/ui-embedded*:
|Property|Default|Description|
|---|---|---|
|`apiUrl` | *http://localhost:8080* | Production Genesys API is at https://api.genesys-pgr.org<br />Sandbox API is at https://api.sandbox.genesys-pgr.org |
|`apiUrl` | *https://api.sandbox.genesys-pgr.org* | Production Genesys API is at https://api.genesys-pgr.org<br />Sandbox API is at https://api.sandbox.genesys-pgr.org |
|`clientId` | **Required** | Please contact helpdesk@genesys-pgr.org to obtain API keys for use in your environment.<br />The API keys are limited to your website and will not work on a different domain. |
|`clientSecret` | **Required** | Ditto. |
|`filter` |`undefined` | Allows for narrowing the scope of requested accession data from Genesys API. <br />To filter for accessions from your genebank, use: `{ institute: { code: ['XXX000'] } }` with the FAO WIEWS Code of your genebank. Default `undefined` value will return all accessions. |
|`language`|`'en'`| Specify the language of the user interface.<br />Fully supported: `en`<br />Partially supported: `es` |
|`title`|`'Genesys |'`| HTML title prefix |
|`language`|*en*| Specify the language of the user interface.<br />Fully supported: `en`<br />Partially supported: `es` |
|`title`| *Genesys:* | HTML page title prefix |
| `accession` | `{ ... }` | See *Accession* configuration options |
| `shoppingCart` | `{ ... }` | See *Shopping cart* configuration options |
......
......@@ -10,6 +10,7 @@ const genesysConfig: Config = {
apiUrl: 'http://localhost:8080',
clientId: 'defaultclient@localhost',
clientKey: 'changeme',
title: 'Testing:',
filter: { institute: { code: [ 'COL003', 'BEL084', 'ETH013' ] } },
language: queryLang,
accession: {
......
......@@ -9,11 +9,11 @@ export class Config {
public filter?: Record<string, any>;
// module config
public language?: string = 'en';
public language: string;
public accession?: AccessionConfig;
public shoppingCart?: BaseFeatureConfig;
public recaptchaSiteKey?: string;
public title?: string = 'Genesys |'
public title?: string;
public constructor(config: Config) {
this.apiUrl = config.apiUrl || defaultConfig.apiUrl;
......@@ -45,7 +45,7 @@ export const defaultConfig: Partial<Config> = {
apiUrl: 'https://api.sandbox.genesys-pgr.org',
filter: {},
language: 'en',
title: 'Genesys | ',
title: 'Genesys:',
accession: {
enabled: true,
pdci: true,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment