Skip to content

Latest commit

 

History

History
136 lines (84 loc) · 3.39 KB

README.md

File metadata and controls

136 lines (84 loc) · 3.39 KB
Raw

CognitiveCanvas

CognitiveCanvas is a Vue.js webapp which serves as a container for webstrates.ucsd.edu. CognitiveCanvas is an active learning tool which uses concept map to motivate students to note, organize, and memorize knowledge in a networked way. Through CognitiveCanvas, we hope to innovate the cognition of students towards knowledge points.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

Download the repository to your local system.

Install all the Project Dependencies

npm install

Establish a MongoDB instance named 'CognitiveCanvas' & Load Data to Database (ATTENTION: The following 3 json files are loaded into 3 DIFFERENT database collections.)

Load Course Resourse Data (articles, blogs, etc)

mongoimport --db CognitiveCanvas --collection contents --file <Path to Your Local Repo>/server/asset/content.json

Load Keyword Data (Keyword to search for resources)

mongoimport --db CognitiveCanvas --collection keywords --file <Path to Your Local Repo>/server/asset/label.json

Load User Data (authorized user)

Build your own authorized_user.json based on the database schema in server/ContainerAPI/app/models/user.js model. The webstrate team's authorized users are omitted in the public repo here for the protection of privacy. (For UCSD CogCanvas Team, you can find this json in our shared Google Drive: "Cognitive Canvas/3_development/DATA LOAD/container_server_asset/". Please DO NOT push to the remote with authorized_user.json!)

mongoimport --db CognitiveCanvas --collection users --file <Path to Your Local Repo>/server/asset/authorized_user.json

Start MongoDB

mongod

Start the Server Side of Cognitive Canvas

navigate to the your local repository and execute following commands:

cd server
npm start

Start the Client Side of Cognitive Canvas

navigate to the your local repository and execute following commands:

cd client
npm start

The CognitiveCanvas webapp should be accessible at port 8080 of local host.

Deployment

A deployed stable version of CognitiveCanvas is published at https://cogcanvas.ucsd.edu/ for now. Please noted that only authorized user are allow to login right now.

Deployment Procedure

Login to the Server and Enter Deployment Directory

Login to the webstrates server using an account with sudoer permission.

cd /home/xizhao/CognitiveCanvas-Container

Set client/src/models/constants.js to be the Deployment Settings

Checkout & Pull the branch you want to deploy; merge branch "Deployment" (which contains the constant.js settings) or manually setting the constants.js:

  1. All the "http" should be modified to "https";

  2. Take out the port number in "api", ex. Delete ":8081";

  3. Make sure all the webstrate templates are the most updated ones.

Deploy Container Vue App

cd client

sudo npm install

sudo npm run-script build

Deploy Server Api

cd server

sudo service nginx restart

Authors

Project Manager

  • Amy Fox

System Dev Team (Name Ranked by First Name)

  • Gaurav "Gav" Parmar
  • Issac Fehr
  • Michael Tolentino
  • Xiangyu "Steve" Zhao
  • Xinwei "Xavier" Wang

User Interface Dev Team

  • Xinwei "Xavier" Wang
  • Helen Cheng
  • Joshua Tjong