fast-web-deployment 1.0.0

package/README.md

@@ -0,0 +1,97 @@
+# Fast Web Deployment
+
+A fast and easy-to-use web deployment tool for Node.js projects with SSH support.
+
+## Features
+
+- 🚀 **Fast Deployment**: Deploy your web projects quickly via SSH
+- 📦 **Multiple Formats**: Support for both tar and zip compression
+- 🔐 **Secure**: Support for both password and private key authentication
+- 📝 **YAML Configuration**: Easy configuration using YAML files
+- 🎯 **Interactive**: User-friendly command-line interface
+- 📦 **Compressed Output**: Automatically generates gzip compressed files for faster downloads
+
+## Installation
+
+```bash
+npm install fast-web-deployment
+```
+
+## Usage
+
+### Basic Usage
+
+```javascript
+import { publishToSsh } from 'fast-web-deployment';
+
+// Deploy using YAML configuration
+const publisher = publishToSsh('./dist', 'my-project', false);
+await publisher.yamlMethod('./config.yml');
+
+// Or deploy using options
+const publisher = publishToSsh('./dist', 'my-project', true);
+await publisher.optionsMethod({
+  host: 'your-server.com',
+  port: 22,
+  username: 'username',
+  password: 'password',
+  method: 'password',
+  sshPublishDirectory: '/var/www/html'
+});
+```
+
+### YAML Configuration
+
+Create a `config.yml` file:
+
+```yaml
+SSH_PRIVATE_KEY: |
+  -----BEGIN RSA PRIVATE KEY-----
+  Your private key here
+  -----END RSA PRIVATE KEY-----
+SSH_HOST: your-server.com
+SSH_PORT: 22
+SSH_USER: username
+SSH_PASSWORD: password
+SSH_PUBLISH_DIRECTORY: /var/www/html
+```
+
+### Options
+
+#### publishToSsh Parameters
+
+- `needCompressionDirectoryPath`: Path to the directory to compress
+- `projectName`: Name of your project
+- `isPassword`: Use password authentication (`true`) or private key (`false`)
+
+#### yamlMethod Parameters
+
+- `yamlPath`: Path to the YAML configuration file
+
+#### optionsMethod Parameters
+
+- `host`: SSH server host
+- `port`: SSH port (default: 22)
+- `username`: SSH username
+- `password`: SSH password (for password authentication)
+- `privateKey`: SSH private key (for key authentication)
+- `method`: Authentication method (`"password"` or `"privateKey"`)
+- `sshPublishDirectory`: Target directory on the server
+
+## Requirements
+
+- Node.js >= 18.0.0
+- SSH access to your server
+- Appropriate permissions on the target directory
+
+## License
+
+MIT
+
+## Author
+
+ITCODE 2021
+
+## Support
+
+For issues and questions, please visit the [GitHub repository](https://github.com/your-username/fast-web-deployment).