Skip to content

Commit e435e2b

Browse files
committed
docs: add license and readme files
Signed-off-by: Pablo Villoslada Puigcerber <pablov@backbase.com>
1 parent 4bf90ed commit e435e2b

File tree

12 files changed

+147
-110
lines changed

12 files changed

+147
-110
lines changed

LICENSE

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Copyright (c) 2018 Backbase B.V.
2+
3+
This Backbase License Agreement (“Agreement”) sets forth the terms and conditions of Your use of the Software that is provided together with this license. If You continue to download the Software, You agree that Your use of the Software, and the use of the Software by any natural or legal person you distribute the Software to, will be covered by this license Agreement. Any third party software that is provided with the Software is included for use at Your option subject to the terms of the license applicable to that software. If You choose to use such software, then such use shall be governed by such third party's license agreement (See Annex A to these terms for an overview of third party software) and not by this Agreement.
4+
5+
1. Definitions
6+
7+
1.1 “Backbase” shall mean Backbase Europe BV, whose place of business is at the INIT Building, Jacob Bontiusplaats 9, 1018 LL Amsterdam, The Netherlands.
8+
9+
1.2 “Documentation” means all online help files or written instruction manuals regarding the Software.
10+
11+
1.3 “Derivative Works” shall mean any Software, whether in source or object form, that is based on (or derived from) the Software and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship.
12+
13+
1.4 “Licensee” or “You” means the individual who downloads the Software and, if you are downloading the Software to be used for or on behalf of a legal entity, the entity on behalf of which you are downloading the Software.
14+
15+
1.5 “Software” means the object code of the computer program(s) Licensee has downloaded and includes any Documentation as provided.
16+
17+
2. Grant of Rights and Restrictions
18+
19+
2.1 License Grant. Backbase grants to Licensee a non-exclusive, non-transferable right and license to: (a) reproduce, modify and prepare Derivative Works of the Software, and (b) use the Software and Derivative Works for its own internal use and, subject to the conditions in section 2.2, distribute the Software and such Derivative Works as an integrated part of commercial products that Licensee makes available on the market (e.g. mobile apps). Any other form of distribution or reselling the Software is not permitted. Except for the express license granted in this Section 2.1, no other licenses are granted.
20+
21+
2.2 Redistribution. Licensee may distribute the Software and such Derivative Works as an integrated part of commercial products Licensee makes available on the market, provided that Licensee meets the following conditions:
22+
23+
a) Licensee must provide any other recipients to whom it distributes the Software or Derivative Works to, with reasonable notice of these terms and the applicability thereof to the use of the Software. Moreover, Licensee shall require such recipients to agree to the terms of this Agreement including its annexes before making the Software available for download; and
24+
b) Licensee must retain in the Software and Derivative Works any “NOTICE” text files (where such notices normally appear) and all copyright, patent, and trademark notices excluding those notices that do not pertain to any part of the Derivative Works. Contents of the NOTICE file are for informational purposes only and do not modify the License.
25+
26+
c) This License does not grant any rights in the patents, trademarks, service marks, or logos of Backbase (except as may be necessary to comply with the notice requirements in Section 2.2).
27+
28+
3. Warranty Disclaimer and Limitation of Liability
29+
30+
THE SOFTWARE IS PROVIDED ON AN "AS IS", ‘WHERE IS” BASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS BORNE BY LICENSEE. IN NO EVENT SHALL BACKBASE BE LIABLE, NOR SHALL LICENSEE HOLD BACKBASE LIABLE, FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, ARISING FROM THE USE OR DISTRIBUTION OF THE SOFTWARE. THIS SECTION 3 CONSTITUTES AN ESSENTIAL PART OF THIS AGREEMENT. THE SOFTWARE MAY NOT BE USED HEREUNDER EXCEPT UNDER THIS DISCLAIMER AND LIMITATION OF LIABILITY.
31+
32+
4. Indemnification by Licensee
33+
34+
Licensee shall defend, indemnify and hold harmless Backbase and its officers, directors, employees and shareholders from and against any and all loss, damage, settlement, costs or expense (including legal expenses and expenses of other professionals), as incurred, resulting from, or arising out of any third party claim which alleges that a Derivative Work infringes upon, misappropriates or violates any intellectual property rights, where such claim is independent of the Software.
35+
36+
5. Applicable Law and Jurisdiction
37+
38+
This Agreement is governed by and interpreted in accordance with the laws of the Netherlands, and Licensee hereby consents to the exclusive jurisdiction and venue of the District Court of Amsterdam.
39+
40+
41+
[Exhibit A– THIRD PARTY COMPONENTS]

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Backbase Micro Frontends
2+
3+
This project is a proof of concept showcasing how our legacy apps (widgets) can work together with our newer apps
4+
(journeys) via Module Federation.
5+
6+
## Examples
7+
8+
We refer to the host app as shell, while the micro-frontends are called remote.
9+
10+
* [legacy-as-remote](legacy-as-remote): Angular 14 shell with journeys and Angular 12 remote with widgets
11+
* [legacy-as-shell](legacy-as-shell): Angular 12 shell with widgets and Angular 14 remote with journeys

legacy-as-remote/README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Legacy as remote
2+
3+
Angular 14 shell with journeys and Angular 12 remote with widgets.
4+
5+
* [remote](angular12)
6+
* [shell](shell)
7+
8+
## Development Setup
9+
10+
### Connect to repo.backbase.com
11+
12+
You need access to [repo.backbase.com](https://repo.backbase.com/) for installing the dependencies. Once you have it you
13+
can follow the [set-up-web-development](https://backbase.io/developers/documentation/web-devkit/getting-started/set-up-web-development/)
14+
guide to configure npm.
15+
16+
### Installing dependencies
17+
18+
To install dependencies, run the following command in each directory:
19+
20+
```bash
21+
$ npm i
22+
```
23+
24+
### Accessing Sandbox
25+
[proxy.env.conf.js](shell/proxy.env.conf.js) is configured to access the [EBP Sandbox](https://backbase.io/ebp-sandbox),
26+
so you can request a key by sending a mail to [api-sandbox-support@backbase.com](mailto:api-sandbox-support@backbase.com).
27+
28+
## Getting Started
29+
30+
### Development server
31+
32+
Run `npm start` in each directory, this will serve both the shell and remote apps.
33+
34+
* [localhost:4200](http://localhost:4200/) (shell)
35+
* [localhost:4202](http://localhost:4202/) (remote)
36+
37+
### Mock server
38+
39+
You can skip authentication but still see data using our [mock-server](../mock-server). In this case, after starting the
40+
mock-server, run `npm run start:mocks` in each directory.

legacy-as-remote/angular12/README.md

-27
This file was deleted.

legacy-as-remote/angular12/src/app/journeys/account-statement-business-journey/account-statement-business-view/account-statement-business-view.component.spec.ts

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { ComponentFixture, TestBed } from '@angular/core/testing';
2+
import { RouterTestingModule } from '@angular/router/testing';
23

34
import { AccountStatementBusinessViewComponent } from './account-statement-business-view.component';
45

@@ -9,6 +10,7 @@ describe('AccountStatementBusinessViewComponent', () => {
910
beforeEach(async () => {
1011
await TestBed.configureTestingModule({
1112
declarations: [AccountStatementBusinessViewComponent],
13+
imports: [RouterTestingModule],
1214
}).compileComponents();
1315
});
1416

legacy-as-remote/shell/README.md

-27
This file was deleted.

legacy-as-shell/README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Legacy as shell
2+
3+
Angular 12 shell with widgets and Angular 14 remote with journeys.
4+
5+
* [remote](angular14)
6+
* [shell](shell)
7+
8+
## Development Setup
9+
10+
### Connect to repo.backbase.com
11+
12+
You need access to [repo.backbase.com](https://repo.backbase.com/) for installing the dependencies. Once you have it you
13+
can follow the [set-up-web-development](https://backbase.io/developers/documentation/web-devkit/getting-started/set-up-web-development/)
14+
guide to configure npm.
15+
16+
### Installing dependencies
17+
18+
To install dependencies, run the following command in each directory:
19+
20+
```bash
21+
$ npm i
22+
```
23+
24+
### Accessing Sandbox
25+
[proxy.env.conf.js](shell/proxy.env.conf.js) is configured to access the [EBP Sandbox](https://backbase.io/ebp-sandbox),
26+
so you can request a key by sending a mail to [api-sandbox-support@backbase.com](mailto:api-sandbox-support@backbase.com).
27+
28+
## Getting Started
29+
30+
### Development server
31+
32+
Run `npm start` in each directory, this will serve both the shell and remote apps.
33+
34+
* [localhost:4200](http://localhost:4200/) (shell)
35+
* [localhost:4204](http://localhost:4204/) (remote)
36+
37+
### Mock server
38+
39+
You can skip authentication but still see data using our [mock-server](../mock-server). In this case, after starting the
40+
mock-server, run `npm run start:mocks` in each directory.

legacy-as-shell/angular14/README.md

-27
This file was deleted.

legacy-as-shell/angular14/src/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
<meta charset="utf-8" />
55
<title>Angular14</title>
66
<base href="/" />
7-
<meta name="viewport" content="width=device-width, initial-scale=1" />
8-
<link rel="icon" type="image/x-icon" href="favicon.ico" />
7+
<meta content="width=device-width, initial-scale=1" name="viewport" />
8+
<link href="favicon.ico" rel="icon" type="image/x-icon" />
99
</head>
1010
<body>
1111
<angular14-element></angular14-element>

legacy-as-shell/shell/README.md

-27
This file was deleted.

legacy-as-shell/shell/src/app/journeys/account-statement-business-journey/account-statement-business-view/account-statement-business-view.component.spec.ts

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { ComponentFixture, TestBed } from '@angular/core/testing';
2+
import { RouterTestingModule } from '@angular/router/testing';
23

34
import { AccountStatementBusinessViewComponent } from './account-statement-business-view.component';
45

@@ -9,6 +10,7 @@ describe('AccountStatementBusinessViewComponent', () => {
910
beforeEach(async () => {
1011
await TestBed.configureTestingModule({
1112
declarations: [AccountStatementBusinessViewComponent],
13+
imports: [RouterTestingModule],
1214
}).compileComponents();
1315
});
1416

mock-server/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Mock Server
2+
3+
## Installation
4+
5+
Run `npm i` to install dependencies.
6+
7+
## Start
8+
9+
Run `npm start` to start the server at [localhost:9999](http://localhost:9999/dev-interface/#/).

0 commit comments

Comments
 (0)