Skip to content

AdamSpera/simwork

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simwork

Project repository for Simwork web app. Powered by JavaScript, mySQL Database and Oracle Cloud.

Introduction

With Simwork, an admin of the program can monitor and collect data from participating users, measuring the users’ productivity and their interactions with other users.

Simwork was created as a method to study the productivity of users when in traditional workspaces, compared to virtual reality workspaces.

Utilizing Oracle Cloud and Cloudflare to host the web app, with HTML, CSS, and Bootstrap on front end, and JavaScript, mySQL, Git, and custom Logwrite NPM package in the back end.

For sustainability, Simwork uses low tier virtual machines and DNS hosting to sustain affordability while not having to compromise on connectivity and latency.

Instructions

When designing Simwork, multiple things were taken into consideration, simple and intuitive visual design, simplistic interactions, simple backend functions, and consistency.

Use Case:

  1. User goes to simwork.co, and inputs their first and last name, followed by whether they are in virtual reality or not. After selecting Submit the user is taken to the dashboard.
  2. At the dashboard the user views the objectives on the side bar and begins completing them by selecting the corresponding card and inputting the correct card details.
  3. If the user is correct, they will be returned to the dashboard to continue working, if not they are notified of an error in their inputting.

Deployment

In the Simwork gitignore file it ignores the node_modules folder and a dotenv ffile.

Deploying this code requires a ".env" file to be located in the root directory with mySQL connection information in it with the following format: "HOST=host_address USERNAME=username PASSWORD=username_password DATABASE=database_name TABLE=table_name” The use of a dotenv file will require the installation of the dotenv npm module (npm i dotenv --save).

Starting the server for the first time requires the user to input "sudo node app" for Linux in the console or "node app" for Windows. The server will run on port 80 by default.

Contributions

Thank you to all these people that served contributions to the Simwork project!

  • Frontend Engineer: Brey H Rivera
  • Backend Engineer: Adam T Spera

Cheers, Adam Spera & Brey Rivera