Merge pull request #58 from VaaS-4-0/dev

added docker image and read me updates

Author: StevenCYTong

README.md

@@ -21,6 +21,8 @@ Visualization as a Service ("VaaS") is an open-source tool that allows users to
 
 VaaS is actively being developed with the support of OSLabs and we are always looking for contributors and feedback.
 
+[Website](https://www.vaas.dev/) | [GitHub](https://github.com/oslabs-beta/VaaS) | [DockerHub](https://hub.docker.com/r/vaasofficial/vaas_official_image)
+
 <br/>
 
 ## Features

SETUP.md

@@ -237,7 +237,9 @@ EXPRESS_CONSOLE_LOG=off
 
 If you're using a cloud database, you can simply copy the connection string and paste it into the environment variable file. If you're using localhost, you will need to install MongoDB and create a database.
 
-Once the above steps are complete, run the following command:
+<br/>
+
+# Run Commands
 
 ```
 npm run dev:server
@@ -249,10 +251,42 @@ npm run dev:server
 yarn dev:server
 ```
 
-_Run the following command if you use a Windows OS:_
+or the following command if you use Windows:
 
 ```
 npm run dev:windows
 ```
 
+<br/>
+
+# Test Commands
+
+To perform end-to-end testing, start a test server through the following command:
+
+```
+npm run test:server
+```
+
+   or the following command if you use Windows:
+
+```
+npm run test:server/windows
+```
+
+Once a test server is running, run the following command:
+
+```
+npx cypress run
+```
+
+Backend testing does not require a running test server. Run the following command to perform testing:
+
+```
+npm run test
+```
+
+# Docker Image
+
+With VaaS 4.0, you can now develop and run the application through a Docker container which has a mongoDB database preconfigured with it. See the ```Docker Compose``` file for details.
+
 <br/>

docker-compose.yaml

@@ -4,7 +4,22 @@ services:
     container_name: vaas
     ports:
       - 3020:3020
-    env_file:
-      - .env
+    # Comment in the following two lines if you want to use your own .env file
+    # env_file:
+    #   - .env
+    # Comment out the following two lines and the mongo service if you want to connect to your own mongo instance
+    environment:
+      - CONTAINER=true
+    # Uncomment the following two lines if you want to use your own source code
+    # volumes:
+    #   - ./src:/usr/src/app/src
+    depends_on:
+      - mongo
+  mongo:
+    image: mongo
+    container_name: mongo
+    restart: always
     volumes:
-      - ./src:/usr/src/app/src
+      - data:/data/db
+volumes:
+  data:

src/server/mongoDb.ts

@@ -22,12 +22,13 @@ class Database {
     url === 'localhost' || url === '127.0.0.1'
       ? (protocol = 'mongodb://')
       : (protocol = 'mongodb+srv://');
-    const uri =
+    let uri =
       username && password
         ? // MODIFY URI SYNTAX BASED ON ADMIN INPUT
           `${protocol}${username}:${password}${url}/${database}?retryWrites=true&w=majority`
         : `${protocol}${url}:${port}/${database}`;
     // INITIATE CONNECTION TO MONGODB
+    if (process.env.CONTAINER) uri = `mongodb://mongo:27017`;
     this._mongo.connect(uri);
     // ASSIGN MONGOOSE CONNECTION TO db
     const db: Connection = this._mongo.connection;