Skip to content

Commit bd17eb1

Browse files
add: Donation section in README
Also re-arranged the sections
1 parent 4417dc1 commit bd17eb1

File tree

2 files changed

+122
-74
lines changed

2 files changed

+122
-74
lines changed

README.md

Lines changed: 122 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,41 @@
1-
<div align="center">
2-
<img src="assets/LogoRound.png" alt="SysAdmin Logo" width="180" />
3-
<h1>SysAdmin</h1>
4-
<p><i><b>Linux server management in your pocket</b></i></p>
5-
6-
<a href="https://github.com/prathameshkhade/SysAdmin/releases" alt="GitHub release"><img src="https://img.shields.io/github/release/prathameshkhade/SysAdmin.svg" ></a>
7-
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
8-
[![Flutter](https://img.shields.io/badge/Made%20with-Flutter-02569B.svg)](https://flutter.dev/)
9-
[![GitHub stars](https://img.shields.io/github/stars/prathameshkhade/SysAdmin)](https://github.com/prathameshkhade/SysAdmin/stargazers)
10-
[![GitHub forks](https://img.shields.io/github/forks/prathameshkhade/SysAdmin)](https://github.com/prathameshkhade/SysAdmin/network/members)
11-
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
1+
<p align="center">
2+
<picture>
3+
<img width="180" src="assets/LogoRound.png" alt="SysAdmin Logo" />
4+
</picture>
5+
<br>
6+
<span style="font-size: 2em; font-weight: bold;">SysAdmin</span>
7+
<br>
8+
<i><b>Linux server management in your pocket</b></i>
9+
<br><br>
10+
<a href="https://apt.izzysoft.de/fdroid/index/apk/com.sysadmin.sysadmin">
11+
<img width="200" src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" alt="Get it on IzzyOnDroid" />
12+
</a>
13+
<a href="https://www.openapk.net/sysadmin-linux-server-management/com.sysadmin.sysadmin/">
14+
<img width="200" src="https://www.openapk.net/images/openapk-badge.png" alt="Get it on OpenAPK" />
15+
</a>
16+
<br><br>
17+
<a href="https://github.com/prathameshkhade/SysAdmin/releases">
18+
<img src="https://img.shields.io/github/release/prathameshkhade/SysAdmin.svg" alt="GitHub release">
19+
</a>
20+
<a href="LICENSE">
21+
<img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3">
22+
</a>
23+
<a href="https://flutter.dev/">
24+
<img src="https://img.shields.io/badge/Made%20with-Flutter-02569B.svg" alt="Flutter">
25+
</a>
26+
<a href="https://github.com/prathameshkhade/SysAdmin/stargazers">
27+
<img src="https://img.shields.io/github/stars/prathameshkhade/SysAdmin" alt="GitHub stars">
28+
</a>
29+
<a href="https://github.com/prathameshkhade/SysAdmin/network/members">
30+
<img src="https://img.shields.io/github/forks/prathameshkhade/SysAdmin" alt="GitHub forks">
31+
</a>
32+
<a href="CONTRIBUTING.md">
33+
<img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg" alt="Contributions welcome">
34+
</a>
35+
<br><br>
36+
</p>
1237

1338
> *"Command your servers, not your schedule. Admin anywhere, anytime."*
14-
</div>
1539
1640
## 🔍 Overview
1741

@@ -44,6 +68,17 @@
4468
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/16.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/16.png)
4569
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/17.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/17.png)
4670

71+
## 🔍 Understanding The Problem
72+
73+
As a Linux system administrator, you may have faced these challenges:
74+
75+
- 💻 **Always needing a laptop** to connect to your servers
76+
- ⏱️ **Time wasted** turning on devices, connecting, and executing repetitive commands
77+
- 🔄 **Repetitive tasks** that could be simplified with a GUI
78+
- 🔋 **Energy consumption** from keeping a laptop running for quick server checks
79+
80+
SysAdmin addresses these issues by providing a comprehensive mobile solution that puts powerful server management tools in your pocket.
81+
4782
## 🌟 Why SysAdmin?
4883

4984
Traditional server management requires either physical access or an SSH session through a terminal, which can be inconvenient when you're on the move. **SysAdmin** solves this by providing:
@@ -58,7 +93,7 @@ Traditional server management requires either physical access or an SSH session
5893
5994
## 🚀 Key Features
6095

61-
### Currently Available
96+
### Currently Available:
6297

6398
- **Dashboard** - View server status, system metrics, and connection details at a glance
6499
- **SSH Manager** - Store and manage multiple server connections securely
@@ -69,7 +104,7 @@ Traditional server management requires either physical access or an SSH session
69104
- **Environment Variables** - Manage both local and global environment variables
70105
- **Terminal** - Full terminal access when you need the command line
71106

72-
### Coming Soon
107+
### Coming Soon:
73108

74109
- **User & Group Management**
75110
- **Service & Log Management**
@@ -79,16 +114,57 @@ Traditional server management requires either physical access or an SSH session
79114
- **Disk & Network Management**
80115
- **VNC Support**
81116

82-
## 🔍 Understanding The Problem
117+
## 🌱 Sustainable Development Goals
83118

84-
As a Linux system administrator, you may have faced these challenges:
119+
SysAdmin contributes to several UN Sustainable Development Goals:
85120

86-
- 💻 **Always needing a laptop** to connect to your servers
87-
- ⏱️ **Time wasted** turning on devices, connecting, and executing repetitive commands
88-
- 🔄 **Repetitive tasks** that could be simplified with a GUI
89-
- 🔋 **Energy consumption** from keeping a laptop running for quick server checks
121+
- **SDG 4 (Quality Education)** - Making server management more accessible to beginners
122+
- **SDG 8 (Decent Work and Economic Growth)** - Increasing productivity and supporting remote work
123+
- **SDG 9 (Industry, Innovation, and Infrastructure)** - Promoting innovation with mobile-friendly server management
124+
- **SDG 11 (Sustainable Cities and Communities)** - Supporting smart infrastructure with less energy usage
125+
- **SDG 17 (Partnerships for the Goals)** - Encouraging open-source collaboration
90126

91-
SysAdmin addresses these issues by providing a comprehensive mobile solution that puts powerful server management tools in your pocket.
127+
## 🛡️ Security Features
128+
129+
Security is our top priority. SysAdmin implements:
130+
131+
- **Local Authentication** - Biometric/pin protection using your device's screen lock
132+
- **Encrypted Communications** - All server communications use SSH/SFTP encryption
133+
- **Secure Credential Storage** - Connection details are stored in your device's secure storage
134+
- **No Server-side Components** - Your credentials never leave your device
135+
136+
## 🚀 Getting Started
137+
138+
### Prerequisites
139+
140+
- Flutter SDK (latest stable version)
141+
- Android Studio or VS Code with Flutter extensions
142+
- A test Linux server with SSH access
143+
144+
### Installation
145+
146+
1. **Clone the repository:**
147+
```bash
148+
git clone https://github.com/prathameshkhade/SysAdmin.git
149+
cd SysAdmin
150+
```
151+
152+
2. **Install dependencies:**
153+
```bash
154+
flutter pub get
155+
```
156+
157+
3. **Run the app:**
158+
```bash
159+
flutter run
160+
```
161+
162+
### Setting up for first time?
163+
164+
1. Launch the app
165+
2. Navigate to SSH Manager and add your first server connection
166+
3. Set your preferred connection as default
167+
4. Explore the dashboard and features!
92168

93169
## 💡 Project Architecture
94170

@@ -134,58 +210,6 @@ lib/
134210
└── main.dart # App entry point
135211
```
136212

137-
## 🛡️ Security Features
138-
139-
Security is our top priority. SysAdmin implements:
140-
141-
- **Local Authentication** - Biometric/pin protection using your device's screen lock
142-
- **Encrypted Communications** - All server communications use SSH/SFTP encryption
143-
- **Secure Credential Storage** - Connection details are stored in your device's secure storage
144-
- **No Server-side Components** - Your credentials never leave your device
145-
146-
## 🌱 Sustainable Development Goals
147-
148-
SysAdmin contributes to several UN Sustainable Development Goals:
149-
150-
- **SDG 4 (Quality Education)** - Making server management more accessible to beginners
151-
- **SDG 8 (Decent Work and Economic Growth)** - Increasing productivity and supporting remote work
152-
- **SDG 9 (Industry, Innovation, and Infrastructure)** - Promoting innovation with mobile-friendly server management
153-
- **SDG 11 (Sustainable Cities and Communities)** - Supporting smart infrastructure with less energy usage
154-
- **SDG 17 (Partnerships for the Goals)** - Encouraging open-source collaboration
155-
156-
## 🚀 Getting Started
157-
158-
### Prerequisites
159-
160-
- Flutter SDK (latest stable version)
161-
- Android Studio or VS Code with Flutter extensions
162-
- A test Linux server with SSH access
163-
164-
### Installation
165-
166-
1. **Clone the repository:**
167-
```bash
168-
git clone https://github.com/prathameshkhade/SysAdmin.git
169-
cd SysAdmin
170-
```
171-
172-
2. **Install dependencies:**
173-
```bash
174-
flutter pub get
175-
```
176-
177-
3. **Run the app:**
178-
```bash
179-
flutter run
180-
```
181-
182-
### First-time Setup
183-
184-
1. Launch the app
185-
2. Navigate to SSH Manager and add your first server connection
186-
3. Set your preferred connection as default
187-
4. Explore the dashboard and features!
188-
189213
## 🤝 Contributing
190214

191215
We welcome contributions from everyone! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.
@@ -204,13 +228,37 @@ Please read our [Contribution Guidelines](CONTRIBUTING.md) before submitting a p
204228
<p>SysAdmin is Free Software: You can use, study, share, and improve it at will.
205229
<p>Specifically you can redistribute and/or modify it under the terms of the <a href="https://www.gnu.org/licenses/gpl.html">GNU General Public License</a> as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
206230

231+
## 💖 Support & Donations
232+
233+
If you find **SysAdmin** helpful, consider supporting the development! Your support helps keep this project open-source and constantly improving 🚀
234+
235+
<p align="center">
236+
<a href="https://www.buymeacoffee.com/prathameshkhade">
237+
<img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=☕&slug=prathameshkhade&button_colour=FFDD00&font_colour=000000&font_family=Comic&outline_colour=000000&coffee_colour=ffffff" alt="Buy Me A Coffee" />
238+
</a>
239+
</p>
240+
241+
<p align="center">
242+
<picture>
243+
<img width="200" style="border-radius: 15px;" src="assets/GooglePay_QR.png" alt="UPI QR Code" />
244+
</picture>
245+
</p>
246+
247+
<p align="center">
248+
You can also donate directly via UPI: <code>pkhade2865@okaxis</code>
249+
</p>
250+
251+
<br>
252+
253+
> Every bit of support means the world 🙏
254+
207255
## 📬 Contact
208256

209257
Questions or feedback? Reach out at [pkhade2865+sysadmin@gmail.com](mailto:pkhade2865+sysadmin@gmail.com) or report an issue [GitHub Issues](https://github.com/prathameshkhade/SysAdmin/issues)
210258

211259
---
212260

213261
<div align="center">
214-
<h3><b>Made with <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="❤️" width="35" height="35" style="vertical-align: middle;" /> by <i>prathameshkhade</i></b></h3>
262+
<h3><b>Made with <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="❤️" width="37" height="38" style="vertical-align: middle;" /> by <i>prathameshkhade</i></b></h3>
215263
<p><i>Because server management shouldn't require a desk.</i></p>
216264
</div>

assets/GooglePay_QR.png

174 KB
Loading

0 commit comments

Comments
 (0)