Skip to content

Commit a29728f

Browse files
authored
feat: example app (#58)
* feat: example app * fix: transfer monitor and init logic for already init and restart flow * fix: improve all page and transfer list * fix: build support and avoid minify * add react installer and compile logic * fix: final changes * fix: build for GH pages * fix: update copyright * fix: build module deploy
1 parent 266a649 commit a29728f

34 files changed

+4125
-427
lines changed

.eslintrc.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ module.exports = {
1010
"plugins": [
1111
"@typescript-eslint",
1212
],
13+
"ignorePatterns": [
14+
"example"
15+
],
1316
"rules": {
1417
"@typescript-eslint/consistent-type-definitions": "error",
1518
"@typescript-eslint/dot-notation": "off",

.github/workflows/documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
- name: Upload Artifact
3737
uses: actions/upload-pages-artifact@v3
3838
with:
39-
path: dist/js
39+
path: dist
4040

4141
- name: Deploy to GitHub Pages
4242
id: deployment

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,6 @@ or copied to a web server for hosting.
2323

2424
## Development
2525
To get started with development, take a look [here](https://github.com/IBM/aspera-sdk-js/blob/main/docs/DEVELOPMENT.md).
26+
27+
## Code Example and test application
28+
You can run the test appp by running `npm run start:example` which will launch the browser to the test app.

example/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# IBM Aspera JavaScript SDK Test Application
2+
3+
Test application for IBM Aspera JavaScript SDK and code sample examples.
4+
5+
## Run application
6+
7+
To run the application first run `npm ci`. Then `npm start` to run the test app in your browser.

example/index.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>IBM Aspera JavaScript SDK Test Application</title>
8+
</head>
9+
<body>
10+
<div id="root"></div>
11+
<script type="module" src="/src/main.tsx"></script>
12+
<script src="sdk-code.js"></script>
13+
</body>
14+
</html>

0 commit comments

Comments
 (0)