wiish - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #llm #deep-learning #linux #windows #cli #kubernetes #awesome-list #security #openai #open-source

wiish

(★ 125)

Why Is It So Hard (to make a cross-platform app)?

파일 탐색기

최종 버전 다운로드 (.zip)

- - main.yml
- .gitignore
- ios_devices.nim
- tounixpath.nim
- .forgit
- config.toml
- README.md
- - buildutil.html
  - buildutil.idx
  - config.html
  - config.idx
- androidutil.html
- androidutil.idx
- async.html
- async.idx
- baseapp.html
- baseapp.idx
- build.html
- build.idx
- common.html
- dochack.js
- doctor.html
- doctor.idx
- events.html
- events.idx
- index.html
- logsetup.html
- logsetup.idx
- mobileutil.html
- mobileutil.idx
- nimdoc.out.css
- resources.html
- resources.idx
- theindex.html
- - main_desktop.nim
  - wiish_build.nim
- - config.nims
  - main.nim
  - wiish_build.nim
- .gitignore
- config.nims
- sample.png
- - .gitignore
  - main_mobile.nim
  - wiish.toml
- - fonts.nim
  - Lato-Regular.ttf
- - basic.nim
  - Inconsolata-Regular.ttf
- - vectors.nim
- .gitignore
- buildforios.sh
- config.nims
- notes.md
- sdlapp.nim
- .gitignore
- config.nims
- dochecks.sh
- formatter.nim
- test_build.nim
- test_events.nim
- - buildutil.nim
  - config.nim
- - standard.nim
  - webview.nim
- androidutil.nim
- async.nim
- baseapp.nim
- build.nim
- common.nim
- doctor.nim
- events.nim
- logsetup.nim
- mobileutil.nim
- resources.nim
.gitignore
builddocs.sh
CHANGELOG.md
config.nims
CONTRIBUTING.md
DEV.md
LICENSE.md
logo.png
nakefile.nim
nim.cfg
README.md
TODO
wiish.nimble
wiishcli.nim

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/iffy/wiish

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd wiish

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.

cd wiish/plugins/webview/data/android-webview/app

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

./gradlew build

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Tests](https://github.com/iffy/wiish/workflows/tests/badge.svg)](https://github.com/iffy/wiish/actions?query=branch%3Amaster)

<div style="text-align:center;"><img src="./logo.png"></div>

[Docs](https://www.iffycan.com/wiish/) | [Changelog](./CHANGELOG.md)

Wiish (Why Is It So Hard) GUI framework might one day make it easy to develop, package and deploy auto-updating, cross-platform applications for desktop and mobile.  If it succeeds, maybe the name will have to change :)

**Wiish is currently ALPHA quality software.**  Don't make anything with it unless you're willing to rewrite it when this package changes.

![Screenshots of macOS, iPhone simulator and Android emulator](https://raw.githubusercontent.com/iffy/wiish/master/img/sample.png)

# Quickstart

1. Install [Nim](https://nim-lang.org/install.html) and `nimble`

2. Install Wiish:

```bash
    nimble install https://github.com/iffy/wiish.git
    ```

3. Find out what other dependencies you need:

```bash
    wiish doctor
    ```

4. Create a project and run it:

```bash
    wiish init somedir
    cd somedir
    wiish run
    ```

See `wiish --help` for more, but here are other examples.  Some only work within a Wiish project:

```
wiish run --os ios-simulator
wiish run --os android
wiish build
```

# Features

Wiish provides:

1. A `wiish` command line tool for running, building and packaging apps.
2. A `wiish` Nim library (i.e. `import wiish/...`) for app-specific helpers (e.g. auto-updating, asset-access, etc...)
3. Plugins for different GUI frameworks: `import wiish/plugins/...`

# Plugins

Wiish uses a plugin system to support various GUI frameworks:

- `wiish/plugins/webview` - For webview apps based on [oskca/webview](https://github.com/oskca/webview).

The GUI component is designed to work separately from other features (e.g. auto-updating, packaging, etc...) so that different GUI libraries can be swapped in/out.

It is hoped that more plugins will be introduced for other GUI frameworks.

## Support Matrix

The following shows the support matrix of **automated** tests.  Actual support may be better or worse than described here.

- `Yes` - For `wiish run`, this means that the application starts and continues running for a few seconds.  For `wiish build` it means the build succeeded.
- `No` - Means it failed
- `-` - Means it's not supported (and isn't planned to be supported)
- `Planned` - Means it doesn't currently work, but we're planning on getting it to work.
- `Untested` - Means that it *might* work when run on a real computer, but our automated tests aren't yet capable of testing it.  For instance, we haven't yet figured out how to run GUI applications on Windows so those are mostly marked `Untested`.

| Host OS | `--os`        | Example      | `wiish run` | `wiish build` |
| ------- | ------------- | ------------ | :---------: | :-----------: |
| windows | android       | webview      |   Planned   |    Planned    |
| windows | mobiledev     | webview      |  Untested   |       -       |
| windows | windows       | plainwebview |  Untested   |    Planned    |
| windows | windows       | webview      |  Untested   |    Planned    |
| linux   | android       | webview      |   Planned   |      Yes      |
| linux   | mobiledev     | webview      |     Yes     |       -       |
| linux   | linux         | plainwebview |     Yes     |    Planned    |
| linux   | linux         | webview      |     Yes     |    Planned    |
| mac     | android       | webview      |     Yes     |      Yes      |
| mac     | ios           | webview      |   Planned   |    Planned    |
| mac     | ios-simulator | webview      |     Yes     |      Yes      |
| mac     | mobiledev     | webview      |     Yes     |       -       |
| mac     | mac           | plainwebview |     Yes     |      Yes      |
| mac     | mac           | webview      |     Yes     |      Yes      |

### GUI-independent features

| Feature                 | macOS | Windows | Linux |  iOS  | Android |
| ----------------------- | :---: | :-----: | :---: | :---: | :-----: |
| App icons               |  Yes  |         |       |  Yes  |   Yes   |
| `wiish run` logs stdout |  Yes  |   Yes   |  Yes  |  Yes  |   Yes   |
| Log files               |       |         |       |       |         |
| Static assets           |  Yes  |         |       |  Yes  |   Yes   |
| Automatic updating      |       |         |       |   -   |    -    |
| File associations       |       |         |       |       |         |
| Menu bar access         |       |         |       |   -   |    -    |

### Distribution formats

| Package           | Supported | Code signing |
| ----------------- | :-------: | :----------: |
| macOS `.dmg`      |           |              |
| Windows Portable  |           |              |
| Windows Installer |           |              |
| Linux `.AppImage` |           |              |
| iOS `.ipa`        |           |              |
| Android `.apk`    |    Yes    |              |

# Examples

See the [`examples`](./examples) directory for more examples of how to use this library.  You can also initialize a project using these examples with `wiish init`.  See `wiish init --help` for information.

# Plugins

## webview

### Messaging

When using the `wiish/plugins/webview` plugin, you send/receive strings between JavaScript and your Nim like this:

In JavaScript do this:

```javascript
window.wiish = window.wiish || {};
wiish.onReady = () => {
    wiish.onMessage(message => {
        // Handle message from Nim
    })
    wiish.sendMessage("Hello Nim! -Sincerely JavaScript");
}
```

In Nim do this:

```nim
import wiish/plugins/webview/desktop
var app = newWebviewDesktopApp()
app.life.addListener proc(ev: DesktopEvent) =
  case ev.kind
  of desktopAppStarted:
    var win = app.newWindow(
      url = some_html_url,
    )
    win.onReady.handle:
      win.sendMessage("Hello JavaScript! -Sincerely Nim")
    win.onMessage.handle(msg):
      discard "Handle message from JavaScript"
app.start()
```

# A note on quality

This library works as advertised, but it is a huge mess.  I'm learning as I'm going, and trying to wrangle all these platforms is ridiculous.  I happily welcome suggestions (and pull requests).

# Developing wiish

See [CONTRIBUTING.md](./CONTRIBUTING.md) for information about contributing to Wiish development.