Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trustedshops-public/connect-app-demo
Demo of connector layer for shop plugin development
https://github.com/trustedshops-public/connect-app-demo
demo-app team-tps-connect tpconnect tsconnect
Last synced: 1 day ago
JSON representation
Demo of connector layer for shop plugin development
- Host: GitHub
- URL: https://github.com/trustedshops-public/connect-app-demo
- Owner: trustedshops-public
- License: mit
- Created: 2023-02-14T15:31:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-15T10:07:00.000Z (8 days ago)
- Last Synced: 2024-12-15T11:19:38.482Z (7 days ago)
- Topics: demo-app, team-tps-connect, tpconnect, tsconnect
- Language: TypeScript
- Homepage:
- Size: 2.79 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Connect App Demo
[](https://github.com/trustedshops-public/connect-app-demo/blob/main/LICENSE)
[](https://sonarcloud.io/summary/new_code?id=trustedshops-public_connect-app-demo)
[](https://sonarcloud.io/summary/new_code?id=trustedshops-public_connect-app-demo)
[](https://sonarcloud.io/summary/new_code?id=trustedshops-public_connect-app-demo)
## Public Documentation
This demo App is part of Trusted Shop´s SDK for building plugins based on our new plattform and architecture. You can find our detailed documentation publicly available [here](https://developers.etrusted.com/docs/introduction). Please follow these instructions to build your own plugin to connect eTrusted products with a shopsoftwaresystem.
## Getting started
#### Node must be installed on the computer to run the demo application https://nodejs.org/en/
### Download example and install dependencies
- Clone this repository:
```sh
git clone [email protected]:trustedshops-public/connect-app-demo.git
```
- Install npm dependencies:
```sh
cd connect-app-demo
npm install
or
yarn install
```
- then
```sh
yarn run dev
or
npm run dev
```
## Let's play the demo
After you have successfully started the app in your browser you will be presented with a pre-configured setup and a login screen.
### Request Development credentials
To authenticate and get the whole experience,you need Client ID and Client Secret of a Trusted Shops members account.
If you haven't any yet, you can get developer credentials at request for testing.
Please write to our support team ([email protected]) to request development credentials.
### Configure your setup
You may change the pre-configuration to your needs.
To do so you want to edit the configuration stated inside baseLayerData in file src/database-container/data-config.ts:
```ts
locale: 'en-GB',
infoSystem: {
nameOfSystem: 'Demo-app',
versionNumberOfSystem: '1.0.0',
versionNumberOfPlugin: '1.0.0',
allowsEstimatedDeliveryDate: true,
allowsEventsByOrderStatus: true,
allowsSendReviewInvitesForPreviousOrders: true,
allowsSendReviewInvitesForProduct: true,
allowsEditIntegrationCode: true,
allowsSupportWidgets: true,
}
```
Further readings: https://developers.etrusted.com/docs/general-concepts
For the demo two sales channels are pre-configured. These represent the frontends of a shop.
You can change them by editing
```ts
salesChannels: [
{
id: 'shop-sales-channel-1',
name: 'Sales Channel EN',
url: 'www.example.com/en',
locale: 'en_GB',
},
{
id: 'shop-sales-channel-2',
name: 'Sales Channel DE',
url: 'www.example.com/de',
locale: 'de_DE',
},
]
```
inside configuration file mentioned above.
Further readings: https://developers.etrusted.com/docs/shop-data-and-channel-setup