-
Notifications
You must be signed in to change notification settings - Fork 2
Admin User Guide
Nils Streedain edited this page Jun 2, 2024
·
3 revisions
- 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
Run the following command to download the latest release (you may need to update the version to a more recent release):
git clone [email protected]:OSU-MC/MyClassroom.git --branch v0.2.0
Navigate to the cloned repository
cd MyClassroom
Install the application dependencies:
npm install
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
- Modify /server/.env to update the MyClassroom Server configuration.
- Modify /client/.env to update the MyClassroom Client configuration.
To automatically start the backend containers, and build/deploy the frontend server with a single command, run the following:
npm run start
Press Ctrl+C to stop the server and shut down the Docker containers.