Files
flutter_server_box/README.md
2023-03-27 21:25:20 +08:00

105 lines
2.9 KiB
Markdown

English | [简体中文](README_zh.md)
<!-- Title-->
<p align="center">
<h1 align="center">Server Box</h1>
</p>
<!-- Badges-->
<p align="center">
<a href="https://apps.apple.com/app/id1586449703">
<img style="height: 37px" src="screenshots/appstore.svg">
</a>
<a href="https://github.com/lollipopkit/flutter_server_box/releases/latest">
<img style="height: 37px" src="screenshots/dl-android.svg">
</a>
</p>
<p align="center">
<a href="https://count.ly/f/badge" rel="nofollow">
<img style="height: 37px" src="https://count.ly/badges/light.svg">
</a>
</p>
<p align="center">
A Flutter project which provide charts to display 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] `Ping` and etc.
- [x] i18n (English, Chinese)
- Welcome contribution :), [How to contribute?](#l10n-guide)
- [x] Desktop support
## 📩 Push
You need to install [ServerBoxMonitor](https://github.com/lollipopkit/server_box_monitor) on your servers.
And config `iOS / Webhook / ServerChan` to push server status to your portable device without using ServerBox app.
## 🆘 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="screenshots/server.jpg">
</td>
<td>
<img width="200px" src="screenshots/detail.jpg">
</td>
<td>
<img width="200px" src="screenshots/ssh.jpg">
</td>
<td>
<img width="200px" src="screenshots/apt.png">
</td>
</tr>
</table>
<table>
<tr>
<td>
<img width="200px" src="screenshots/ping.png">
</td>
<td>
<img width="200px" src="screenshots/sftp.jpg">
</td>
<td>
<img width="200px" src="screenshots/docker.jpg">
</td>
<td>
<img width="200px" src="screenshots/convert.png">
</td>
</tr>
</table>
## 🖥 Platform
Status|Platform
--- | ---
Full Support| Android / iOS / macOS
Support, but not tested| Windows / Linux
## 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
`GPL v3. lollipopkit 2023`