ibraheem007 commited on
Commit
73508e7
·
verified ·
1 Parent(s): aceaa8c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -47
README.md CHANGED
@@ -1,47 +1,20 @@
1
- # TailorED - AI-Powered Educational Content Generator
2
-
3
- A research prototype that uses AI to generate personalized educational content for students and tutors.
4
-
5
- ## What is TailorED?
6
-
7
- TailorED helps create tailored educational content:
8
- - **For Students**: Simplifies complex course material into easy-to-understand explanations
9
- - **For Tutors**: Generates lesson plans, study guides, and teaching materials
10
-
11
- ## Quick Start
12
-
13
- 1. **Install dependencies**:
14
- ```bash
15
- pip install -r requirements.txt
16
-
17
- 2. **Set up Environment Variables**:
18
- ```bash
19
- # Create .env file with your Groq API keys
20
- GROQ_API_KEY_1=your_first_groq_key
21
- GROQ_API_KEY_2=your_second_groq_key
22
- DB_NAME=your-db-name
23
- DB_USERNAME=your-postgre-username
24
- DB_PASSWORD=your-postgre-password
25
- DB_HOST=localhost
26
- DB_PORT=5432
27
- MODEL_URL=url-of-research-model
28
-
29
- 3. **Run the App**:
30
- ```bash
31
- streamlit run app.py
32
-
33
- 4. **Recommended .env Template**:
34
- ```bash
35
- # .env
36
- # Get your Groq API key from: https://console.groq.com
37
- # 1. Go to console.groq.com
38
- # 2. Create account/login
39
- # 3. Click "API Keys" in top right
40
- # 4. Create new key and copy it
41
- # 5. Paste below:
42
-
43
- # Minimum setup (one key):
44
- GROQ_API_KEY_1=your_actual_groq_key_here
45
-
46
- # Optional: Add second key for better reliability:
47
- # GROQ_API_KEY_2=your_second_groq_key_here
 
1
+ ---
2
+ title: Semi
3
+ emoji: 🚀
4
+ colorFrom: red
5
+ colorTo: red
6
+ sdk: docker
7
+ app_port: 8501
8
+ tags:
9
+ - streamlit
10
+ pinned: false
11
+ short_description: NLP 2025 Research work
12
+ license: mit
13
+ ---
14
+
15
+ # Welcome to Streamlit!
16
+
17
+ Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
18
+
19
+ If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
20
+ forums](https://discuss.streamlit.io).