Skip to content

update setup #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .abapgit.xml

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/build_web.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- uses: actions/setup-node@v4
- run: npm ci
- run: npm run clone
- run: npm run unit
- run: npm run build && node output/index.mjs
- run: npm run webpack:build
- name: deploy to web-abap2ui5-samples
uses: peaceiris/actions-gh-pages@v4
Expand All @@ -30,4 +30,4 @@ jobs:
user_email: 'github-actions[bot]@users.noreply.github.com'
publish_branch: main
force_orphan: true
publish_dir: ./build
publish_dir: ./build
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
node_modules
downport
node_modules
abap2UI5
abap2UI5-samples
output
src
build
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 oblomov
Copyright (c) 2024 abap2UI5

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
59 changes: 45 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,54 @@
# abap2UI5-web
## abap2UI5-Setup

Run abap2UI5 with [**open-abap**](https://github.com/open-abap) on Node.js
### Functionality
* Downporting with [abaplint](https://abaplint.org/)
* Transpiling to JS with [abaplint/transpiler](https://github.com/abaplint/transpiler)
* Running on Node.js with [open-abap](https://github.com/open-abap/express-icf-shim)
* Service exposing via [express-icf-shim](https://github.com/open-abap/express-icf-shim)
* Browser Tests with [Playwright](https://playwright.dev/)
* Webpacking, Unit Testing...

Live Demo:<br>
https://abap2ui5.github.io/web-abap2ui5-samples/

## Test
### Tasks
#### Downport & Transpile
```
npm run init
npm run build
```
#### Run Unit Tests
```
npm run clone
npm run unit
```
#### Run Webservice
```
npm run express
```
#### Run Playwright Tests
```
npm run init_play
npx playwright install --with-deps && npm i
npx playwright test
```

#### Webpack Build Strategy

1. Clone repositories into /src/
2. Downport /src/ into /downport/
3. Transpile with express-icf-shim into /output/
4. Webpack backend + frontend + database into folder build

```
npm run webpack:build
```
### Overview
<img width="800" alt="image" src="https://github.com/user-attachments/assets/97cc8b91-4a0b-4f22-9501-6655117c9c24">

### Demo
#### Running on Node.js
![306716361-7d0fa7e5-2c5b-46c4-b2e8-0ffd70350370](https://github.com/user-attachments/assets/a170cc1e-2521-4f86-b59e-d852bbd656ee)

## Build Strategy
#### Backend Runnning in Browser
[https://abap2ui5.github.io/web-abap2ui5-samples/](https://abap2ui5.github.io/web-abap2ui5-samples/)

1. Clone repositories into `/src/`
2. Downport `/src/` into `/downport/`
3. Transpile with [express-icf-shim](https://github.com/open-abap/express-icf-shim) into `/output/`
4. Webpack backend + frontend + database into folder `build`

## Demo
![gif_open_abap](https://github.com/abap2UI5/abap2UI5-web/assets/102328295/7d0fa7e5-2c5b-46c4-b2e8-0ffd70350370)
### Credits
* abaplint, open-abap, express-icf-shim etc. all by [larshp](https://github.com/larshp)
252 changes: 0 additions & 252 deletions abaplint.jsonc

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion abap_transpile.json → ci/abap_transpile.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"ignoreSyntaxCheck": false,
"addFilenames": true,
"addCommonJS": true,
"extraSetup": "../test/setup.mjs",
"extraSetup": "../ci/setup.mjs",
"unknownTypes": "runtimeError",
"skipReposrc": true,
"keywords": ["return", "in", "class", "for", "delete", "var"],
Expand Down
Loading