-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b10be8e
commit b720bcc
Showing
1 changed file
with
15 additions
and
6 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,9 +1,18 @@ | ||
## Welcome to tutify.org! | ||
# Welcome to tutify.org! π¨βπ« | ||
|
||
We're happy that you're interested in becoming part of our tutify community! | ||
|
||
Here, you will find the documentation of the project and everything you need to know: | ||
* How it works | ||
* How to get involved | ||
* How to start your local tutify.org | ||
* ... | ||
|
||
Let's start to give a brief overview about our code. | ||
|
||
## Code | ||
The code to run a tutify.org platform consists of differnt parts which are structured like the following | ||
* **Screening Tool** β a tool that is used to verify tutors (university students) via an internet video identity check | ||
* _Backend_ which provides the API and acts as a bridge between the following two components... | ||
* _Tutors Frontend_ which is the frontend part that the tutors use in the verification process | ||
* _Screener Frontend_ which is the frontend part that the screeners of a tutify-organization use to verify tutors | ||
* **Matching Algorithm** β a complex and highly optimized mathematical algorithm that is used to do matchings between tutors and tutees. | ||
* **User platform** β sophisticated platform where tutors and tutees can manage their matches, data etc. and which is protected via a login process. | ||
* _Backend_ which provides and API and manage emails, user data etc. | ||
* _User platform_ which provides the web frontend | ||
|