Git Product home page Git Product logo

strohgelaender / artemis Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ls1intum/artemis

0.0 0.0 0.0 119.23 MB

Artemis - Interactive Learning with Automated Feedback

Home Page: https://artemis.ase.in.tum.de

License: MIT License

JavaScript 1.11% Java 46.44% HTML 11.14% Scala 1.20% TypeScript 37.90% Dockerfile 0.06% Shell 0.24% Python 0.33% C 0.02% Haskell 0.03% SCSS 1.15% Assembly 0.08% Kotlin 0.05% VHDL 0.02% Swift 0.13% CSS 0.08% OCaml 0.01%

artemis's Introduction

Artemis: Interactive Learning with Individual Feedback

Build Status Test Status Documentation Status Dependency Status Dev Dependency Status Code Quality Status Coverage Status

Artemis was initially generated using JHipster 6.10.3. (Documentation and help)

Latest version)

Main features

Artemis supports the following exercises:

  1. Programming exercises with version control and automatic assessment with test cases and continuous integration
  2. Quiz exercises with multiple choice, drag and drop and short answer quiz questions
  3. Modeling exercises with semi-automatic assessment using machine learning concepts
  4. Text exercises with manual (and experimental semi-automatic) assessment
  5. File upload exercises with manual assessment

Artemis supports all these exercises to run either live in the lecture with instant feedback or as homework. Students can submit their solutions multiple times within the due date and use the (semi-)automatically provided feedback to improve their solution.

Artemis also supports an exam mode now. You can find more information on Exam mode student features and on Exam mode instructor features.

Setup, guides and contributing

Development setup, coding and design guidelines

Documentation

Read the Docs hosts the Artemis documentation. You can find a guide on how to write documentation.

Server setup

You can find the guide for setting up Artemis in conjunction with either GitLab and Jenkins here or with Jira, Bitbucket and Bamboo here. Artemis uses these external tools for user management and the configuration of programming exercises.

Administration setup

You can find information on how to set up user registration here

Contributing

Please read the guide on how to contribute to Artemis.

Building for production

To build and optimize the Artemis application for production, run:

./gradlew -Pprod -Pwar clean bootWar

This will create a Artemis-.war file in the folder build/libs. The build command compiles the TypeScript into JavaScript files, concatenates and minifies the created files (including HTML and CSS files). It will also modify index.html so it references these new files. To ensure everything worked, run the following command to start the application on your local computer:

java -jar build/libs/*.war --spring.profiles.active=dev,artemis,bamboo,bitbucket,jira

(You might need to copy a yml file into the folder build/libs before, also see development setup)

Then navigate to http://localhost:8080 in your browser.

Refer to Using JHipster in production for more details.

The following command can automate the deployment to a server. The example shows the deployment to the main Artemis test server (which runs a virtual machine):

./artemis-server-cli deploy [email protected] -w build/libs/Artemis-4.4.5.war

Architecture

The following diagram shows the top level design of Artemis which is decomposed into an application client (running as Angular web app in the browser) and an application server (based on Spring Boot). For programming exercises, the application server connects to a version control system (VCS) and a continuous integration system (CIS). Authentication is handled by an external user management system (UMS).

Top-Level Design

While Artemis includes generic adapters to these three external systems with a defined protocol that can be instantiated to connect to any VCS, CIS or UMS, it also provides 3 concrete implementations for these adapters to connect to:

  1. VCS: Atlassian Bitbucket Server
  2. CIS: Atlassian Bamboo Server
  3. UMS: Atlassian JIRA Server (more specifically Atlassian Crowd on the JIRA Server)

Server architecture

The following UML component diagram shows more details of the Artemis application server architecture and its REST interfaces to the application client.

Server Architecture

Deployment

The following UML deployment diagram shows a typical deployment of Artemis application server and application client. Student, Instructor and Teaching Assistant (TA) computers are all equipped equally with the Artemis application client being displayed in the browser.

The Continuous Integration Server typically delegates the build jobs to local build agents within the university infrastructure or to remote build agents, e.g. hosted in the Amazon Cloud (AWS).

Deployment Overview

Data model

The Artemis application server uses the following (simplified) data model in the MySQL database. It supports multiple courses with multiple exercises. Each student in the participating student group can participate in the exercise by clicking the Start Exercise button. Then a repository and a build plan for the student (User) will be created and configured. The initialization state helps to track the progress of this complex operation and allows recovering from errors. A student can submit multiple solutions by committing and pushing the source code changes to a given example code into the version control system or using the user interface. The continuous integration server automatically tests each submission, and notifies the Artemis application server, when a new result exists. In addition, teaching assistants can assess student solutions and "manually" create results.

Data Model

Please note, that the actual database model is more complex. The UML class diagram above omits some details for readability (e.g. lectures, student questions, exercise details, static code analysis, quiz questions, exam sessions, submission subclasses, etc.)

Artemis Community

There is a growing community of university instructors who are using Artemis.

Communication

We communicate using Github issues and pull requests. Additionally, you can join us on Slack to ask questions and get support. If you are interested, please send an email to Stephan Krusche.

Universities with Artemis in Use

The following universities are actively using Artemis or are currently evaluating Artemis.

Technical University of Munich
LFU Innsbruck, Uni Salzburg, JKU Linz, AAU Klagenfurt, TU Wien
University of Stuttgart
Universität Bonn
Universität Passau
Karlsruhe Institute of Technology

artemis's People

Contributors

anditurdiu avatar derlalla avatar fde312 avatar filip-gregurevic avatar frankelukas avatar fuchsdominik avatar hanyaelhashemy avatar ivanchimeno avatar josiasmontag avatar jpbernius avatar jwilland-tum avatar kloessst avatar krusche avatar lovaiible avatar madwau avatar maisikoleni avatar maximilianmeier avatar maxr96 avatar muenchdo avatar nicolasruscher avatar rpadovani avatar sascha11110 avatar schultek avatar siggz avatar simonentholzer avatar sleiss avatar thilo-behnke avatar tobiaspr avatar ungaralex avatar vschlattinger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.