Skip to content

1. How To Install OpenCourse

martingasparyan edited this page Mar 8, 2021 · 4 revisions

Installing OpenCourse

Since we have not yet published OpenCourse on the internet, using the application currently requires a local installation on the end user's pc. Before actually installing OpenCourse, we need to assure that your system has the necessary runtime and package manager required for using the application.

  1. In a terminal emulator, run node -v to check if you have Node.js installed. If you do, you should get a version output such as v15.8.0

    • If your machine outputs something else such as command not found, then download Node.js from their official website here
  2. Next, clone the OpenCourse repository from Github here using git clone https://github.com/cs130-w21/9 or simply just download the repository as a .zip file.

  3. Now open a terminal window and change your directory using cd 9 into the '9' directory within the downloaded repository. Now running ls will output multiple files / folders of which two are opencourse-app and opencourse-backend. One folder is for the frontend environment and the other is for the backend one.

  4. Within that terminal window, run the command npm install in the 9-master directory, then change directories once more into opencourse-app using cd opencourse-app and then run the command npm install to install the required dependencies that your system may not have.

    • Note you will also have to run npm install @material-ui/core if npm install from above did not do so already for you. Material UI is the react framework that our app uses for the card motifs.
    • Additionally, within the same 'opencourse-app' directory you must also run npm install firebase for the firebase module which is used to verify logging in.

An example of the above commands can be seen in the image below. Simply change the target commands as required.

Screen Shot 2021-03-06 at 12 05 20 AM

Once all of the above are completed successfully, the installation of the application is finished and you can move on to the next steps here in the manual to begin using the application.

Clone this wiki locally