Skip to content

Commit be743a2

Browse files
authored
Update README.md
1 parent 73f84d1 commit be743a2

File tree

1 file changed

+51
-72
lines changed

1 file changed

+51
-72
lines changed

README.md

Lines changed: 51 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Youdemy
22

3+
Youdemy is a teching platform that empowers teachers to upload unlimited content divided by courses and lessos so that students across the world can access these resources.
4+
35
## Programmers
46

57
| Name | Email | Github |
@@ -9,91 +11,74 @@
911
| Fiorella Hernandez | [email protected] | fiorellaV |
1012
| Jose Manuel De Pablo Cobo | [email protected] | pablocjm |
1113

12-
## Description
13-
14-
Our web application will be a teaching platform where students will be able to acquire courses from teachers around the world.
14+
## PHASE 0: APLICATION FUNCTIONALITIES
1515

16-
## Users
16+
### ENTITIES
1717

18-
- Guest
19-
- Student
20-
- Teacher
21-
- Administrator
18+
Our application has 4 different entities
19+
* **USER** - The applications users. There are different types of users in our application:
20+
* Student
21+
* Teacher
22+
* Aministrator
23+
* **COURSE** - This entity represents a course that only a teacher has permission to create.
24+
* **LESSONS** - This entity represents the lessons that are within a course each with their own information and are created at the time of creating and editing a course.
25+
* **ORDER** - This entity represents the purchasing process of a user and it stores the information of what courses are owned by what users.
2226

27+
### Users
28+
Within the user entity there are different types of users;
2329

24-
### Guests
30+
* **GUEST** - is the type of user that doesnt sign up for an account and has only access to view the course catalog and the main description of courses.
31+
* **STUDENT** - is the type of user that signs up for a student account and has the additional option of purchasing courses and accessing the lessons within the course.
32+
* **TEACHER** - Teachers are the creators within the application. They can create courses and lessons and upload or enter the information. They can also delete and edit the courses they own.
33+
* **ADMINISTRATOR** - Administrators are able to edit or delete any course or lessons and they also have access to their dashboard where they can see all of the web application information.
2534

26-
- Search Content
2735

28-
### Students
36+
### USER PERMISSION
2937

38+
Students
3039
- Search Content
3140
- Buy courses
32-
- Review courses based on stars
33-
- Leave comments
34-
35-
### Teachers
3641

42+
Teachers
3743
- Create courses
38-
- Create different topics inside the course
39-
- Upload videos
40-
- Request video removal
41-
42-
### Administrators
44+
- Create different lessons inside the course
45+
- Upload video url
46+
- delete owned courses and lessons
47+
- edit owned courses and lessons
4348

49+
Administrators
4450
- Search Content
45-
- Approve course
46-
- Eliminate Course
47-
- Ban users
51+
- Delete any course
52+
- Edit any course
4853
- Visualize stastistics
49-
50-
## Tables
51-
52-
- User
53-
- Order
54-
- Course
55-
- Video
56-
57-
## User
58-
- userID or mail
59-
- name
60-
- lastname
61-
- age
62-
- role (student, teacher)
63-
64-
## Order
65-
- orderID
66-
- userID (FK)
67-
- courseID (FK)
68-
- paymentMethod
69-
- price
70-
- orderDate
71-
72-
## Course
73-
- CourseID
74-
- courseName
75-
- Category (tech, finance, law)
76-
- price
77-
- enrolledStudents
78-
79-
## Video
80-
- videoId
81-
- videoName
82-
- videoDataa
83-
- courseID (FK)
8454

8555

86-
## Additional Technology
87-
- PDF generator
88-
- Play Video
56+
### Additional Technology
57+
Generate a pdf with the order information so that user can download this information
8958

90-
## Algorithm
91-
Search algorithm for courses (ajax)
59+
### Advanced Algorithm
60+
Search algorithm for courses (ajax).
9261

93-
## Graphics
62+
### Graphics
9463
Administrators will be able to check visual information about courses
9564

96-
# What every developer did
65+
### Screens
66+
67+
The application consists of the following screens:
68+
69+
### Navigation Diagram
70+
The following diagram shows how users can navigate through the different pages of the application according to their role.
71+
![Navigation Diagram](/diagrams_and_images/Navigation_Diagram.png)
72+
73+
### Class Diagram
74+
The following diagram shows the different classes in our web application.
75+
![Class Diagram](diagrams_and_images/Class_Diagram.png)
76+
77+
### Class Diagram
78+
The following diagram shows our database infrastructure/schema.
79+
![Database Diagram](/diagrams_and_images/database_schema.jpeg)
80+
81+
### CONTRIBUTIONS
9782

9883
## Emiliano Sloth
9984
- Restful Error Handling
@@ -124,14 +109,8 @@ Administrators will be able to check visual information about courses
124109
- AJAX course loading
125110
- Course search
126111

127-
# Diagrams
128-
![Class Diagram](diagrams_and_images/Class_Diagram.png)
129-
![Database Diagram](/diagrams_and_images/database_schema.jpeg)
130-
![Navigation Diagram](/diagrams_and_images/Navigation_Diagram.png)
131-
132-
133112

134-
# Start coding
113+
### Start coding
135114
Follow these steps to get working:
136115

137116
1. Clone the repo `git clone https://github.com/CodeURJC-DAW-2021-22/webapp10`.

0 commit comments

Comments
 (0)