Merge pull request #7 from wellwelwel/wellwelwel-templates

chore: update issue templates
wellwelwel · Aug 4, 2023 · 0b3f1ba · 0b3f1ba
2 parents 5955666 + a669f2d
commit 0b3f1ba
Show file tree

Hide file tree

Showing 19 changed files with 104 additions and 105 deletions.
diff --git a/.github/ISSUE_TEMPLATE/blank-📄.md b/.github/ISSUE_TEMPLATE/blank-📄.md
@@ -0,0 +1,7 @@
+---
+name: "Blank \U0001F4C4"
+about: Describe your issue
+title: ''
+labels: ''
+assignees: ''
+---
diff --git a/.github/ISSUE_TEMPLATE/bug-report-🕵🏻.md b/.github/ISSUE_TEMPLATE/bug-report-🕵🏻.md
@@ -0,0 +1,35 @@
+---
+name: "Bug report \U0001F575\U0001F3FB"
+about: Create a report to help improve SVPS
+title: ''
+labels: ''
+assignees: ''
+---
+
+### 🌧️ What's wrong?
+
+> Describe the issue
+
+---
+
+### 🧙🏻 Reproducing
+
+> It's easier to follow and solve the issue if ew can reproduce it
+
+---
+
+### 🖥️ Environment
+
+- **OS**
+  - [ ] Linux
+  - [ ] Mac (Intel)
+  - [ ] Mac (M1/2)
+  - [ ] Windows
+  - [ ] Other:
+- **SVPS version:**
+  - ...
+- **Node.js version**
+  - [ ] 16.x
+  - [ ] 18.x
+  - [ ] 20.x
+  - [ ] Other:
diff --git a/.github/assets/readme/license.svg b/.github/assets/readme/license.svg
diff --git a/.github/assets/readme/node.svg b/.github/assets/readme/node.svg
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ You will need these tools installed on your system:
 
 ## Developing
 
-Fork this project, download your forked repository locally and create a new branch.  
+Fork this project, download your forked repository locally and create a new branch from `main`.  
 Then running `npm ci` to install the dependecies from _package-lock.json_.
 
 ---

diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
 <div align="center">
   <h1>SVPS - Simplifying VPS</h1>
   <p>🚀 An easier tool to automate your <b>Ubuntu Server</b> setup and domain forwarding</p>
-  <img src="https://img.shields.io/npm/v/svps?style=flat" alt="npm">
-  <img src="https://img.shields.io/github/actions/workflow/status/wellwelwel/svps/ci.yml?event=push&style=flat&label=ci&branch=main" alt="GitHub Workflow Status (with event)">
-  <img src="https://img.shields.io/npm/dt/svps?style=flat" alt="npm">
+  <a href="https://www.npmjs.com/package/svps"><img src="https://img.shields.io/npm/v/svps?style=flat" alt="npm"></a>
+  <a href="https://github.com/wellwelwel/svps/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/wellwelwel/svps/ci.yml?event=push&style=flat&label=ci&branch=main" alt="GitHub Workflow Status (with event)"></a>
+  <a href="https://www.npmjs.com/package/svps"><img src="https://img.shields.io/npm/dt/svps?style=flat" alt="npm"></a>
+  <a href="https://github.com/wellwelwel/svps/blob/main/LICENSE"><img src="https://raw.githubusercontent.com/wellwelwel/svps/main/.github/assets/readme/license.svg" alt="License"></a>
 </div>
 
 ## Table of Contents
@@ -21,13 +22,12 @@
     - [Advanced Usage](#advanced-usage-manual)
   - [Turning **VPS Server** into **Desktop Server** (**RDP**)](#turning-vps-server-into-desktop-server-rdp)
   - [Testing using a **Docker** Container](#testing-using-a-docker-container)
+  - [Close the Connection](#close-the-connection)
 - [Important](#important)
   - [Known Issues](#known-issues)
   - [Compatibility](#compatibility)
-  - [License](#license)
 - [Community](#community)
   - [Contributing](#contributing)
-  - [Credits](#credits)
 
 ---
 
@@ -37,7 +37,7 @@
 
 It supports command automation, files and directories upload via **SFTP**, automatic installations and configurations, domain forwarding, local text files and template strings into _escaped quoted strings_ for dynamic remote file creation, among other features.
 
-All this, using just a single one connection 🧙🏻✨
+All this, using just a _single one_ connection 🧙🏻✨
 
 ---
 
@@ -52,13 +52,24 @@ All this, using just a single one connection 🧙🏻✨
 ```js
 import { SVPS } from 'svps';
 
+/** Prepare the connection */
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
     username: 'root',
     password: 'root',
   },
 });
+
+/** Available methods
+ * svps.mount
+ * svps.commands
+ * svps.createVirtualHosts
+ * svps.upload
+ * svps.end
+ *
+ * See about each below 🕵🏻
+ */
 ```
 
 ---
@@ -262,6 +273,14 @@ await svps.mount({
 
 ---
 
+### Close the Connection
+
+```js
+await svps.end();
+```
+
+---
+
 ## Important
 
 - This package is designed for pre-built **VPS**, **KVM** and **Ubuntu Server** `>=18.04`
@@ -288,12 +307,6 @@ await svps.mount({
 
 ---
 
-### License
-
-[![License](/.github/assets/readme/license.svg)](/LICENSE)
-
----
-
 ## Community
 
 I'm continuously working to improve **SVPS**. If you've got something interesting to share, feel free to submit a [**Pull Request**](https://github.com/wellwelwel/svps/compare). If you notice something wrong, I'd appreciate if you'd open an [**Issue**](https://github.com/wellwelwel/svps/issues/new).
@@ -303,11 +316,3 @@ I'm continuously working to improve **SVPS**. If you've got something interestin
 ### Contributing
 
 Please check the [_CONTRIBUTING.md_](./CONTRIBUTING.md) for instructions 🚀
-
----
-
-### Credits
-
-| Contributors | GitHub                                                                            |
-| ------------ | --------------------------------------------------------------------------------- |
-| Author       | [![wellwelwel](/.github/assets/readme/author.svg)](https://github.com/wellwelwel) |
diff --git a/examples/commands/ssh-welcome-message/index.ts b/examples/commands/ssh-welcome-message/index.ts
@@ -16,8 +16,8 @@ const quotedBashrc = escapeQuotes(bashrc);
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 

diff --git a/examples/crontab/index.ts b/examples/crontab/index.ts
@@ -12,8 +12,8 @@ import { SVPS } from '../../lib/index.js';
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 

diff --git a/examples/default/index.ts b/examples/default/index.ts
diff --git a/examples/desktop/index.ts b/examples/desktop/index.ts
@@ -12,8 +12,8 @@ import { SVPS } from '../../lib/index.js';
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 

diff --git a/examples/ftp/index.ts b/examples/ftp/index.ts
@@ -12,16 +12,16 @@ import { SVPS } from '../../lib/index.js';
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 
 await svps.mount({
   users: [
     {
       name: 'support',
-      password: String(process.env.SUPPORT_PASS),
+      password: 'support-password',
       ftp: {
         /** default options */
         directory: '/home/support',

diff --git a/examples/mysql/index.ts b/examples/mysql/index.ts
@@ -12,8 +12,8 @@ import { SVPS } from '../../lib/index.js';
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 
@@ -27,12 +27,12 @@ await svps.mount({
       {
         host: '127.0.0.1',
         name: 'local_user',
-        pass: String(process.env.DB_PASS),
+        pass: 'local_user-passowrd',
       },
       {
         host: '192.168.0.1',
         name: 'external_user',
-        pass: String(process.env.DB_PASS),
+        pass: 'external_user-password',
       },
     ],
   },

diff --git a/examples/node/index.ts b/examples/node/index.ts
@@ -12,16 +12,16 @@ import { SVPS } from '../../lib/index.js';
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 
 await svps.mount({
   users: [
     {
       name: 'manager',
-      password: String(process.env.MANAGER_PASS),
+      password: 'manager-password',
       sftp: {
         chRoot: '/home/manager',
         chUser: '/home/manager/apps',

diff --git a/examples/php/index.ts b/examples/php/index.ts
@@ -12,16 +12,16 @@ import { SVPS } from '../../lib/index.js';
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 
 await svps.mount({
   users: [
     {
       name: 'manager',
-      password: String(process.env.MANAGER_PASS),
+      password: 'manager-password',
       sftp: {
         chRoot: '/var/www',
         chUser: '/var/www/domains',

diff --git a/examples/rsa/index.ts b/examples/rsa/index.ts
@@ -12,8 +12,8 @@ import { SVPS } from '../../lib/index.js';
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 

diff --git a/examples/sftp/index.ts b/examples/sftp/index.ts
@@ -12,16 +12,16 @@ import { SVPS } from '../../lib/index.js';
 const svps = new SVPS({
   access: {
     host: '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
+    username: 'root',
+    password: 'root',
   },
 });
 
 await svps.mount({
   users: [
     {
       name: 'support',
-      password: String(process.env.SUPPORT_PASS),
+      password: 'support-password',
       sftp: {
         /** default options */
         mask: '077',

diff --git a/examples/upload/index.ts b/examples/upload/index.ts
@@ -2,10 +2,9 @@ import { SVPS } from '../../lib/index.js';
 
 const svps = new SVPS({
   access: {
-    host: process.env?.HOST || '127.0.0.1',
-    username: String(process.env.USER),
-    password: process.env.PASS,
-    port: Number(process.env.PORT) || 22,
+    host: '127.0.0.1',
+    username: 'root',
+    password: 'root',
   },
 });