Skip to content

Commit 9339ad0

Browse files
committed
Add README
Signed-off-by: Jesús Castro <x51v4n@gmail.com>
1 parent de7fa47 commit 9339ad0

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# MateFacil Demo
2+
3+
Demonstration version of **MateFacil** - A web app to evaluate skills and knowledge.
4+
5+
**MateFacil** is a web app to help both professors and students to learn and evaluate the skills and knowledge gained from the semester's course.
6+
In this particular case, we decided to create a web app that can create or 'generate' mathematical problems.
7+
On this first version (MateFacil 0.1) we focus on arithmethical and inequality problems.
8+
9+
This demo shows a partial approach about how the solution was implemented for the version `0.1`.
10+
11+
This repository will be used as a reference for the new developers coming to work for the project next semester and/or upcoming periods.
12+
13+
This project is being hosted at the FOSS (Free and Open Source Software) organization **Tecnológico Mario Molina Open Source** and the main purpose for this is to
14+
invite students to learn and adopt community and colaborational efforts to work on a project.
15+
16+
The main challenge of this version focus on how to execute existing code on a web app.
17+
The existing code refers to the generators and validators of the mathematical problems, some of them are written in C, C++ and Java.
18+
19+
In our glossary we define:
20+
- **Generator**: A piece of software that generates a _unique_ mathematical problem, say arithmetical, and once that the problem is generated it's shown on a web page that the student will be able to see.
21+
- **Validator**: Another piece of software that validates the input given by the user, in this case when a student finishes an arithmetical exercise an introduces his solution through the web page.
22+
23+
On this demo you will be able to execute a web app and see how it runs C, C++ and Java code thanks to Python's subprocesses and Django framework.
24+
All of the C, C++ and Java source has the purpose to be used as an example on how to make them work on a web app.
25+
Have saying that, there's no generator nor validator included for this demo.
26+
27+
28+
## What will you see on this demo?
29+
A simple web app showing the functionality of Python's subprocesses.
30+
31+
Screenshot:
32+
33+
![example](https://imgur.com/sx0SX0p.jpg)
34+
35+
36+
## Steps to reproduce on your local machine
37+
38+
### Requirements
39+
- Python 3.8.3
40+
- Django 3.0.7
41+
- OpenJDK 14
42+
- G++ (GCC) 10.1.0
43+
44+
Once you have all the requirements installed:
45+
- Download this repository
46+
- `cd matefacil`
47+
- `python manage.py runserver 0.0.0.0:8000`
48+
- Go to your browser at 0.0.0.0:8000
49+
- Enjoy!
50+
51+
52+
---
53+
### Authoring
54+
- [Luis Manuel Chávez Velasco](https://github.com/ManueLord21)
55+
- [Jesús Castro](https://github.com/jcstr)
56+
57+
Licence: GNU General Public License v3.0

0 commit comments

Comments
 (0)