Skip to content

Commit b297dad

Browse files
committed
Refactor code structure for improved readability and maintainability
1 parent 82eb014 commit b297dad

File tree

6 files changed

+17
-10
lines changed

6 files changed

+17
-10
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ Feature requests are welcome! When suggesting features, please:
9797

9898
### Requirements
9999

100-
- PHP 8.0+ with extensions: `ftp`, `session`, `zlib`, `ssh2` (optional)
101-
- Composer
100+
- PHP 8.0+ with extensions: `ftp`, `session`, `zlib`
101+
- Composer (required for phpseclib/phpseclib ^3.0.7)
102102
- Web server (Apache or Nginx)
103103

104104
### Installation

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@
3737
## 📸 Screenshots
3838

3939
### Login Page
40-
![Login Page](.github/images/screenshot-login.png)
40+
![Login Page](docs/images/screenshot-login.png)
4141

4242
### File Manager
43-
![File Manager](.github/images/screenshot-home.png)
43+
![File Manager](docs/images/screenshot-home.png)
4444

4545
### Integrated Code Editor
46-
![Code Editor](.github/images/screenshot-code.png)
46+
![Code Editor](docs/images/screenshot-code.png)
4747

4848
---
4949

@@ -52,22 +52,24 @@
5252
### Requirements
5353

5454
- **PHP 8.0+** (8.0, 8.1, 8.2, 8.3)
55+
- **Composer** (for dependency management)
5556
- **PHP Extensions:**
5657
- `ftp` (for FTP connections)
5758
- `session` (for session management)
58-
- `ssh2` (optional - for advanced operations)
5959
- `zlib` (optional - for compression)
60+
- **Required Package:**
61+
- `phpseclib/phpseclib` ^3.0.7 (for SSH operations)
6062
- **Web Server:** Apache with mod_rewrite OR Nginx
6163
- **HTTPS** recommended for production
6264

6365
### Installation
6466

6567
```bash
6668
# 1. Clone the repository
67-
git clone https://github.com/yourusername/webcodeftp.git
69+
git clone https://github.com/codebyoul/webcodeftp.git
6870
cd webcodeftp
6971

70-
# 2. Install dependencies (optional - autoloader included)
72+
# 2. Install dependencies (REQUIRED)
7173
composer install
7274

7375
# 3. Configure your FTP server
@@ -143,6 +145,8 @@ WebCodeFTP uses a **single configuration file** at `config/config.php`. This is
143145

144146
### 2. SSH Configuration (Optional - Recommended)
145147

148+
**SSH operations powered by [phpseclib](https://github.com/phpseclib/phpseclib) 3.0.7** - A pure PHP SSH implementation.
149+
146150
**Why use SSH over FTP?** SSH provides **significantly better performance** for advanced operations:
147151

148152
| Operation | FTP Method | SSH Method | Performance |
@@ -269,9 +273,10 @@ PHP, JavaScript, TypeScript, HTML, CSS, Python, Java, C, C++, Go, Rust, Ruby, Sw
269273
- Check `session.save_path` in php.ini
270274

271275
### SSH features not working
272-
- Install `php-ssh2` extension: `sudo apt install php-ssh2`
276+
- Run `composer install` to ensure phpseclib is installed
273277
- Verify SSH credentials in `config/config.php`
274278
- Test SSH connection: `ssh username@hostname`
279+
- Check logs: `tail -f logs/app.log`
275280

276281
### "Invalid security token"
277282
- Enable cookies in your browser
@@ -299,6 +304,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
299304
Built with amazing open-source technologies:
300305

301306
- [CodeMirror 6](https://codemirror.net/) - The powerful code editor
307+
- [phpseclib 3.0.7](https://github.com/phpseclib/phpseclib) - Pure PHP SSH implementation
302308
- [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework
303309
- [Font Awesome](https://fontawesome.com/) - Beautiful icons
304310
- PHP 8.0+ - Modern, fast, and secure

composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
}
2323
],
2424
"require": {
25-
"php": ">=8.0"
25+
"php": ">=8.0",
26+
"phpseclib/phpseclib": "^3.0.7"
2627
},
2728
"require-dev": {},
2829
"autoload": {
82.9 KB
Loading
54.4 KB
Loading
324 KB
Loading

0 commit comments

Comments
 (0)