-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Rewrite the Readme with more recent screenshots * Delete unused images * Improve wording in Readme * Use iconography for feature list * Add footer to Readme * Redact header line * Unify screenshot summary titles * Improve wording in about section * Address wording according to review * Make distinction to other platforms more clear
- Loading branch information
Showing
11 changed files
with
96 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,121 @@ | ||
| <p align="center"> | ||
| <img src="https://user-images.githubusercontent.com/37160523/228801673-236a081f-40e9-47ca-add6-da1b2d6de3fa.png" width="200px" /> | ||
| <div align="center"> | ||
| <a href="https://mampf.mathi.uni-heidelberg.de/"> | ||
| <img src="https://user-images.githubusercontent.com/37160523/228801673-236a081f-40e9-47ca-add6-da1b2d6de3fa.png" | ||
| width="130px" alt="MaMpf Logo"/> | ||
| </a> | ||
| <div align="center"> | ||
| <h3 align="center">MaMpf</h3> | ||
| <p> | ||
| <strong>Mathematical Media Platform for universities</strong> | ||
| </p> | ||
| </div> | ||
| <div align="center"> | ||
| <a href="https://mampf.mathi.uni-heidelberg.de">Website (🇩🇪/🇺🇸)</a> | ||
| | <a href="https://mampf.blog/">Blog (🇩🇪)</a> | ||
| | <a href="https://mampf-hd.github.io/mampf/">User docs (🇩🇪)</a> | ||
| | <a href="https://github.com/MaMpf-HD/mampf/wiki">Dev wiki (🇺🇸)</a> | ||
| <br><sub>Create your own free account <a href="https://mampf.mathi.uni-heidelberg.de">here</a>. | ||
| Note the <a href="https://mampf-hd.github.io/mampf/">user docs</a> are outdated with respect to the screenshots showcased over there.</sub> | ||
| </div> | ||
| </div> | ||
|
|
||
| <h3 align="center">MaMpf</h3> | ||
| <p align="center">Mathematische Medienplattform</p> | ||
| </p> | ||
| ## 💡 About / Motivation | ||
|
|
||
| ## 💡 About | ||
| MaMpf is an innovative open source e-learning platform for the mathematical sciences developed at the [Institute for Mathematics at Heidelberg University](https://www.math.uni-heidelberg.de/en). It's actively used in teaching and learning; you can [register for free here](https://mampf.mathi.uni-heidelberg.de/) (no student email required). Our platform is fully available in English & German. | ||
|
|
||
| **MaMpf (*Mathematische Medienplattform*)** is an innovative open source E-Learning platform for the mathematical sciences. | ||
| Central point is the interconnection between different content in the sense | ||
| of a hypermedia system. | ||
| <a href="https://mampf.mathi.uni-heidelberg.de/"> | ||
| <img width="1178" alt="MaMpf landing page used to log in" src="https://github.com/MaMpf-HD/mampf/assets/37160523/4a671aa4-134c-4d4a-9f00-aeeacd3ccebd"> | ||
| </a> | ||
|
|
||
| MaMpf uses the contextual classification of a course as visual leitmotiv, | ||
| instead of organizational aspects. | ||
| MaMpf aims to be a hypermedia system for mathematical content. Like _moodle_, it provides a platform for lecturers to upload & organize their teaching material including videos and scripts. But MaMpf goes beyond that and eases learning through interconnected contents: | ||
| - 🎞 **Lecture videos** can be enriched with a navigation that allows students to jump to specific parts of the video, e.g. mathematical definitions, theorems, examples etc. References to other media are also possible, e.g. to different lecture videos / quizzes / worked examples etc. | ||
| - 🏷 Any media can be **tagged** with keywords. This allows students to easily find content related to a specific topic and discover how items are connected in a **graph view**. | ||
| - 🕹 Interactive **quizzes** allow students to test their understanding of the material. The system can automatically evaluate the answers and provide direct feedback, e.g. explain why an answer is wrong or provide a link to the relevant part of the video or an additional "worked example" video. | ||
| - 👩🏫 Students can sign up for tutorials and form teams themselves. Tutors are then able to manage the groups and upload corrected homework assignments for their students. | ||
| - 🗨 A **comment system** allows students to ask questions about the material in the context of the specific video/script or in a general forum. Lecturers will get a notification when a new comment is posted (of course adjustable). Students may choose their own alias name when posting comments in order to stay anonymous. | ||
|
|
||
|  | ||
| This is just a brief overview of the feature set. You may think of MaMpf as a mix of _Moodle_, _Khan Academy_ and _YouTube_. But it's more than that as features are tailored to the needs of the mathematical sciences and a university context. Start exploring MaMpf [here](https://mampf.mathi.uni-heidelberg.de/). | ||
|
|
||
| MaMpf comes with its own hypermedia player and editor THymE | ||
| (*The hypermedia Experience*). ThymeE uses the internal structure of | ||
| mathematical content (consisting of theorems, remarks, definitions etc.) and allows | ||
| exact navigation between content that is related, but temporally apart. | ||
| References can be created not only to content within the same video, but within | ||
| the whole MaMpf database. | ||
|
|
||
|  | ||
| ## 📷 Screenshots | ||
|
|
||
| ThymE is lean and makes use of WebVTT and HTML5 video capabilites | ||
| of modern browsers. A sample hypervideo can be found | ||
| [here](https://mampf.mathi.uni-heidelberg.de/media/384/play). | ||
| To give you a closer look, here are some **screenshots** taken from our live system: | ||
|
|
||
| MaMpf is equipped with a tagging system and rich visualisations for content relations, | ||
| making use of [cytoscape.js](http://js.cytoscape.org/). | ||
| <details> | ||
| <summary>Video player</summary> | ||
|
|
||
| Try out the video player [here](https://mampf.mathi.uni-heidelberg.de/media/384/play) (even without any account). Press `i` to open the outline on the right. It can hold references to other parts of the video or other items in the whole MaMpf database. The player makes use of WebVTT and HTML5 video capabilities of modern browsers. | ||
|
|
||
|  | ||
| <a href="https://mampf.mathi.uni-heidelberg.de/media/384/play"> | ||
| <img src="https://github.com/MaMpf-HD/mampf/assets/37160523/ff049eeb-3c25-4db0-a21e-efd51e566256" alt="MaMpf video player"/> | ||
| </a> | ||
| </details> | ||
|
|
||
| MaMpf has a quiz system that allows you to create complex quizzes quite easily. | ||
| <details> | ||
| <summary>Courses overview</summary> | ||
|
|
||
| Here, users can select courses from the current semester or from previous ones. | ||
|
|
||
|  | ||
|  | ||
| </details> | ||
|
|
||
| MaMpf makes use of the JS based symbolic math expression evaluator | ||
| [nerdamer](https://github.com/jiggzson/nerdamer) to parse student's input in quizzes. | ||
| <details> | ||
| <summary>Lectures overview</summary> | ||
|
|
||
| In the lectures view, users can click on a lecture to see the video. | ||
|
|
||
|  | ||
| </details> | ||
|
|
||
| For more information see this [blog](https://mampfdev.wordpress.com). | ||
| There you can also find a [screenshot gallery](https://mampfdev.wordpress.com/gallery/). | ||
| ## System background | ||
| <details> | ||
| <summary>Graph tag search</summary> | ||
|
|
||
| MaMpf is equipped with a tagging system and rich visualizations for content relations, making use of [cytoscape.js](http://js.cytoscape.org/). | ||
|
|
||
| [](https://dashboard.cypress.io/projects/v45wg9/runs) | ||
| [](https://codecov.io/gh/MaMpf-HD/mampf) | ||
|  | ||
| </details> | ||
|
|
||
| MaMpf is implemented in Ruby on Rails. | ||
| <details> | ||
| <summary>Quizzes</summary> | ||
|
|
||
| * Ruby version: 3.1.4 | ||
| * Rails Version: 7.0.4.3 | ||
| * Test suite: rspec, cypress | ||
| * support for I18n | ||
| Users can play quizzes in MaMpf and get immediate feedback. In order to parse student's input in quizzes (e.g. when they enter a symbolic expression), MaMpf makes use of the JS based symbolic math expression evaluator [nerdamer](https://github.com/jiggzson/nerdamer). | ||
|
|
||
| ## 💻 Installation (with docker compose) | ||
|  | ||
|
|
||
| To easily try out MaMpf you can use `docker compose`. Clone the MaMpf repository and run `docker compose`: | ||
| Lecturers can create quizzes and edit them in a graph: | ||
|
|
||
| ``` | ||
|  | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Comments</summary> | ||
|
|
||
| Users can post comments directly on videos. LaTeX is supported and rendered via [KaTeX](https://katex.org/). | ||
|
|
||
|  | ||
| </details> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## 💻 Installation | ||
|
|
||
| MaMpf is a **Ruby on Rails** application with a **PostgreSQL** database. For our frontend styling, we rely on **Bootstrap**. Our [website](https://mampf.mathi.uni-heidelberg.de/) is hosted on a server at Heidelberg University. We use docker (compose) for development and deployment. | ||
|
|
||
| MaMpf is actively developed & maintained. If you are interested in using MaMpf at your university, please get [in touch](mailto:[email protected]). But please note that we're a very small team and can't provide support for setting up your own instance of MaMpf at the moment. Our [installation guide](./INSTALL.md) should be a good starting point. We have to admit, though, that getting your own instance up and running might involve quite some effort including setting up a mail server, the database, SSL certificates, an nginx web server / proxy, deploying the Ruby on Rails application, and more. | ||
|
|
||
| To clone the source code and build MaMpf locally with `docker compose`, run these commands: | ||
|
|
||
| ```bash | ||
| git clone -b main --recursive https://github.com/MaMpf-HD/mampf.git | ||
| cd mampf/docker/development/ | ||
| docker compose up | ||
| docker compose up -d | ||
| ``` | ||
|
|
||
| See the full installation guide [here](./INSTALL.md). | ||
| See the full installation guide [here](./INSTALL.md). There you will also find out how to init your local database with some sample data. | ||
|
|
||
| <a href="https://mampf.mathi.uni-heidelberg.de/"> | ||
| <img src="https://github.com/MaMpf-HD/mampf/assets/37160523/c3454b01-a3cb-4fab-90f7-cb097075c56f" | ||
| alt="MaMpf footer"/> | ||
| </a> |
Binary file not shown.
Empty file.
Empty file.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.