Files
flutter_server_box/README.md
2023-08-20 22:55:32 +08:00

109 lines
3.6 KiB
Markdown

English | [简体中文](README_zh.md)
<!-- Title-->
<p align="center">
<img src="imgs/flutter_server_box.png">
</p>
<!-- Badges-->
<p align="center">
<a href="https://apps.apple.com/app/id1586449703">
<img style="height: 37px" src="imgs/appstore.svg">
</a>
<a href="https://count.ly/f/badge" rel="nofollow">
<img style="height: 37px" src="https://count.ly/badges/dark.svg">
</a>
<a href="https://github.com/lollipopkit/flutter_server_box/releases/latest">
<img style="height: 37px" src="imgs/dl-android.svg">
</a>
</p>
<p align="center">
A Flutter project which provide charts to display <a href="../../issues/43">Linux</a> server status and tools to manage server.
<br>
Especially thanks to <a href="https://github.com/TerminalStudio/dartssh2">dartssh2</a> & <a href="https://github.com/TerminalStudio/xterm.dart">xterm.dart</a>.
</p>
## 🔖 Feature
- [x] Functions
- [x] `SSH` Terminal, `SFTP`
- [x] `Docker & Pkg` Manager
- [x] `Status` charts
- [x] `Code editor`
- [x] `Ping` and etc.
- [x] Localization ( English, 简体中文, Deutsch, 繁體中文, Indonesian. [l10n guide](#l10n-guide) )
- [x] Desktop support
## 📩 Push
In order to push server status to your portable device without opening ServerBox app (Such as **message push** and **home widget**), you need to install [ServerBoxMonitor](https://github.com/lollipopkit/server_box_monitor) on your servers, and config it correctly. See [Wiki](https://github.com/lollipopkit/server_box_monitor/wiki) for more details.
## 🆘 Help
If you have any question or feature request, please open a [discussion](https://github.com/lollipopkit/flutter_server_box/discussions/new/choose).
If ServerBox app has any bug, please open an [issue](https://github.com/lollipopkit/flutter_server_box/issues/new).
## 🏙️ ScreenShots
<table>
<tr>
<td>
<img width="200px" src="imgs/server.png">
</td>
<td>
<img width="200px" src="imgs/detail.png">
</td>
<td>
<img width="200px" src="imgs/sftp.png">
</td>
<td>
<img width="200px" src="imgs/editor.png">
</td>
</tr>
</table>
<table>
<tr>
<td>
<img width="200px" src="imgs/ping.png">
</td>
<td>
<img width="200px" src="imgs/ssh.jpg">
</td>
<td>
<img width="200px" src="imgs/docker.jpeg">
</td>
<td>
<img width="200px" src="imgs/convert.png">
</td>
</tr>
</table>
## 🖥 Platform
Status|Platform
--- | ---
Full Support| Android / iOS / macOS
Not tested| Windows / Linux
## 🧱 Contribution
**Any positive contribution is welcome**.
10 iOS app redemption codes will be given away for the first time you participate in the contribution. :)
### l10n guide
1. Fork this repo and clone forked repo to your local machine.
2. Create `arb` file in `lib/l10n/` directory
- File name should be `intl_XX.arb`, where `XX` is the language code. Such as `intl_en.arb` for English and `intl_zh.arb` for Chinese.
3. Add content to the file. You can refer to `intl_en.arb` and `intl_zh.arb` for the format.
4. Run `flutter gen-l10n` to generate files.
5. Pull commit to your forked repo.
6. Request a pull request on my repo.
## 📝 License
- You can package it for personal use, but you can't distribute it.
- For example: You can teach others how to package it to avoid spending money to buy App, but you can't directly distribute the App you packaged.
- Why do I have to do this?
- Security: If anyone inject malicious code into the source code and distribute it, it will cause a lot of trouble.
- Income: Apple developer account = $99 per year. As a freshly graduated independent developer, I need income.
- Except for the above, apply the `GPLv3` license.