Adnan083 commited on
Commit
75220a6
Β·
verified Β·
1 Parent(s): 6f04227

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +45 -11
README.md CHANGED
@@ -1,11 +1,3 @@
1
- ---
2
- title: README
3
- emoji: πŸ¦€
4
- colorFrom: gray
5
- colorTo: pink
6
- sdk: streamlit
7
- pinned: false
8
- ---
9
  # app.py
10
  import streamlit as st
11
  from multipage import MultiPage
@@ -16,6 +8,10 @@ app = MultiPage()
16
 
17
  # Title and description
18
  st.set_page_config(page_title="EduConnect", layout="wide")
 
 
 
 
19
  st.title("πŸ“š EduConnect: Platform for Teachers and Students")
20
  st.markdown("Empowering teachers and students with seamless collaboration and learning.")
21
 
@@ -26,10 +22,48 @@ app.add_page("Student's Hub", student_page.app)
26
  # Run the app
27
  app.run()
28
 
29
- # requirement.txt
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
  streamlit
31
  pandas
32
  numpy
 
33
 
34
-
35
- Edit this `README.md` markdown file to author your organization card.
 
 
 
 
 
 
 
 
 
 
 
 
1
  # app.py
2
  import streamlit as st
3
  from multipage import MultiPage
 
8
 
9
  # Title and description
10
  st.set_page_config(page_title="EduConnect", layout="wide")
11
+
12
+ # Add an image to the homepage
13
+ st.image("./images/education_banner.png", use_column_width=True)
14
+
15
  st.title("πŸ“š EduConnect: Platform for Teachers and Students")
16
  st.markdown("Empowering teachers and students with seamless collaboration and learning.")
17
 
 
22
  # Run the app
23
  app.run()
24
 
25
+ # README.md
26
+ ![EduConnect Banner](./images/education_banner.png)
27
+
28
+ # EduConnect
29
+ EduConnect is a platform designed to bridge the gap between teachers and students, offering seamless interaction, assignment management, and educational tools.
30
+
31
+ ## Features
32
+ - πŸ“‚ Upload and manage course materials
33
+ - πŸ§‘β€πŸ« Teacher's Portal for assignments and monitoring
34
+ - πŸŽ“ Student's Hub for accessing learning resources and submitting assignments
35
+ - πŸ“Š Monitor progress and conduct quizzes
36
+
37
+ ## How to Run
38
+ 1. Clone the repository
39
+ 2. Install dependencies:
40
+ ```
41
+ pip install -r requirements.txt
42
+ ```
43
+ 3. Run the app:
44
+ ```
45
+ streamlit run app.py
46
+ ```
47
+
48
+ ## Screenshots
49
+ ### Homepage
50
+ ![Homepage](./images/homepage.png)
51
+
52
+ ### Teacher's Portal
53
+ ![Teacher's Portal](./images/teacher_portal.png)
54
+
55
+ ### Student's Hub
56
+ ![Student's Hub](./images/student_hub.png)
57
+
58
+ ## Requirements
59
+ ```
60
  streamlit
61
  pandas
62
  numpy
63
+ ```
64
 
65
+ Ensure you have images stored in the `images` folder:
66
+ - `education_banner.png` for the homepage
67
+ - `homepage.png` for homepage screenshot
68
+ - `teacher_portal.png` for teacher's portal screenshot
69
+ - `student_hub.png` for student's hub screenshot