Skip to content

Admin User Guide

Nathan Rumsey edited this page Jun 1, 2025 · 4 revisions

Install Application

1. Install Docker

  • Docker is used to containerize multiple segments of the backend application.
  • Refer to the Get Docker Guide for installing and setting up Docker.
    • For advanced users with headless server deployments, Docker CLI is recommended.
    • For less advanced installations, and development, Docker Desktop is recommended for simpler configuration and troubleshooting

2. Download Open-Response

Run the following command to download the latest release (you may need to update the version to a more recent release):

git clone git@github.com:OSU-MC/Open-Response.git --branch v0.2.0

3. Install Dependencies

Navigate to the cloned repository

cd Open-Response

Install the application dependencies:

npm install

Configure Environment

To customize the application, you must modify the environment variables for both the front and backend. To use the the default values, run the following command:

npm run config

Note: When running the config script, you can modify the default values it you then save

Manually Configure

  • Modify /server/.env to update the Open-Response Server configuration.
  • Modify /client/.env to update the Open-Response Client configuration.

Start Application

To automatically start the backend containers, and build/deploy the frontend server with a single command, run the following:

npm run start

Stop Application

Press Ctrl+C to stop the server and shut down the Docker containers.

Clone this wiki locally