Merge pull request #4 from AnechaS/develop

Update documents and Fix version dependencies

Author: AnechaS

.gitignore

@@ -2,7 +2,6 @@
 .vscode
 node_modules
 dist
-package-lock.json
 yarn-error.log
 yarn.lock
 build

.nvmrc

@@ -0,0 +1 @@
+12.22

README.md

@@ -1,44 +1,43 @@
-#Gateway Database
+# Database Gateway
 
-เป็นระบบช่วยแก้ปัญหาเมื่อคุณไม่สามารถเชื่อมต่อฐานข้อมูลภายนอกด้วย VPN หรือวิธีอื่นๆได้ (ฐานข้อมูลไม่ได้เปิดเป็น Public) โดยระบบนี้จะใช้ความสามารถของ [TCP protocal](https://en.wikipedia.org/wiki/Transmission_Control_Protocol) ในการเข้าถึงฐานข้อมูลที่เชื่อมต่อกับโปรแกรมฝั่งเซิร์ฟเวอร์ที่เราพัฒนา (โปรแกรมฝั่ง Client) ซึ่งหลักการทำงานคือ ผู้ใช้ส่ง Request คำสั่ง SQL ไปทาง API จากนั้น Server ก็จะไปควบคุมโปรแกรมผั่ง Client ที่เชื่อมต่ออยู่กับฐานข้อมูล ให้รันคำสั่ง SQL และนำผลลัพกลับไป
+This system is designed to solve the problem of being unable to connect to an external database through VPN or other methods (where the database is not open to the public). It utilizes the TCP protocol to access the database connected to the client-side program that we have developed (the client program). The basic concept is that the user sends a SQL command request through the API, and then the server controls the client-side program connected to the database to execute the SQL command and return the results.
 
-This system will help solve the problem. When you are unable to connect to an external server using VPN or other methods, using the [TCP protocol] capability to access the database connected to the client-side program.
+> *เป็นระบบช่วยแก้ปัญหาเมื่อคุณไม่สามารถเชื่อมต่อฐานข้อมูลภายนอกด้วย VPN หรือวิธีอื่นๆได้ (ฐานข้อมูลไม่ได้เปิดเป็น Public) โดยระบบนี้จะใช้ความสามารถของ TCP protocal ในการเข้าถึงฐานข้อมูลที่เชื่อมต่อกับโปรแกรมฝั่งเซิร์ฟเวอร์ที่เราพัฒนา (โปรแกรมฝั่ง Client) ซึ่งหลักการทำงานคือ ผู้ใช้ส่ง Request คำสั่ง SQL ไปทาง API จากนั้น Server ก็จะไปควบคุมโปรแกรมผั่ง Client ที่เชื่อมต่ออยู่กับฐานข้อมูล ให้รันคำสั่ง SQL และนำผลลัพกลับไป*
 
-## Command
-
-### Install
+## Installation
 
 ```bash
-git clone https://github.com/Anechasun/api-gateway-database.git
-cd api-gateway-database
+git clone https://github.com/Anechasun/database-gateway.git
+cd database-gateway
 
 npm install
 ```
 
-### Run API Server 
+## Server
 
 ```bash
 npm run start-server
 ```
 
-### Start Client app for develop
+## Client
 
 ```bash
 npm start
 ```
 
-### Build Client app to file install
+### Create installable app file
 
 ```bash
 npm run build
 ```
 
-
 ## Usage
 
-#### 1. Run API Server
+#### 1. Start Server.
+
+#### 2. Start Client app.
 
-#### 2. Open the Client app and Configure the database.
+#### 3. Set up database in Client app.
 
 **`Driver`**: Database types (postgresql, mysql, microsoft-sql-server)
 
@@ -48,21 +47,21 @@ npm run build
 
 **`Username`**: Username used to establish the connection.
 
-**`Password`**:  Password used to establish the connection.
+**`Password`**: Password used to establish the connection.
 
 **`Database`**: Database name.
 
 **`Code`**: Client unique id.
 
 <img src="resources/screen-connect.png" width="400" height="500" />
 
-#### 3. Send request to server
+#### 4. Retrieve data in the database.
 
-this example api [see](https://github.com/Anechasun/gateway-database/blob/master/server/index.js#L21)
+This is just a demo API. You can customize it as needed, as shown in this example code [server/index.js](https://github.com/Anechasun/database-gateway/blob/master/server/index.js#L21).
 
 ```bash
 curl -X GET \
   'http://localhost:3000/query?sql=SELECT * FROM users'
 ```
-<img src="resources/screen-data.jpg" width="400" height="500" />
 
+<img src="resources/screen-data.jpg" width="400" height="500" />

config.js

@@ -1,4 +1,4 @@
-exports.APP_NAME = 'Gateway Database';
+exports.APP_NAME = 'Database Gateway';
 exports.APP_URL = 'http://localhost:3000';
 exports.APP_WS_URL = 'ws://localhost:3000';
 exports.DEVELOPMENT_MODE = Boolean(process.env.ELECTRON_DEVELOP);

docker-compose.yml

@@ -6,28 +6,12 @@ services:
     restart: unless-stopped
     ports:
       - 3306:3306
-    # volumes:
-    #   - "mysql_data:/var/lib/mysql"
     environment:
       MYSQL_ROOT_PASSWORD: 123456
     container_name: mysql
     tty: true
     networks:
       - net
-  phpmyadmin:
-    image: phpmyadmin
-    restart: unless-stopped
-    ports:
-      - 8888:80
-    environment:
-      - PMA_ARBITRARY=1
-    container_name: phpmyadmin
-    networks:
-      - net
-
-# volumes:
-#   mysql_data:
-#     driver: local
 
 networks:
   net: