diff --git a/.dockerignore b/.dockerignore index 2c93340..6a3b1a3 100644 --- a/.dockerignore +++ b/.dockerignore @@ -24,3 +24,9 @@ docs/ .gitignore Dockerfile +modules/PointerProjectEngine/ +modules/ThreadingProjectEngine/ + +plugins/email_notice +plugins/gtest +plugins/make_c diff --git a/README.md b/README.md index 6dcbc68..a88d512 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,31 @@ MAGI is a python framework for generating programming assignments and autograder | ARM | Not Supported | --- -## Getting Started +## Quick Start -### Prerequisites +The easiest way to get started with our application is by using our pre-built Docker image. -- Python 3.10 +```bash +docker run -d --name magi -p 8501:8501 -v ./settings:/app/settings ghcr.io/cics-syslab/magi:latest +``` -### Installation - +### Docker Compose +```yaml +version: '3' +services: + magi: + image: ghcr.io/cics-syslab/magi:latest + volume: + - ${pwd}/settings:/app/settings + network_mode: bridge + ports: + - "8501:8501" +``` + +## Building from Source + +If you prefer to build the application from source, follow the instructions in the [Building from Source](#building-from-source) page. + ## Usage -Start the gui +Access the web interface through http://host:port + -- Enabled Plugins: + -### Preview + -### Upload the autograder to Gradescope +### Upload the autograder to Gradescope -In gradescope, select Ubuntu-22.04 as base image and upload the generated zip file. +In gradescope, select Ubuntu-22.04 as base image and upload the generated zip file.