Spaces:
Configuration error
Configuration error
Upload 6 files
Browse files- CHANGELOG.md +4 -0
- CONTRIBUTING.md +9 -0
- README.md +12 -17
- REPORT.md +56 -0
- app.py +45 -0
- requirements.txt +5 -2
CHANGELOG.md
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Changelog
|
| 2 |
+
|
| 3 |
+
## [Unreleased]
|
| 4 |
+
- Initial setup of the Streamlit application.
|
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing Guidelines
|
| 2 |
+
|
| 3 |
+
Thank you for considering contributing to our project. Here's how you can help:
|
| 4 |
+
|
| 5 |
+
- **Bug Reports**: Submit issues with detailed descriptions.
|
| 6 |
+
- **Feature Requests**: Suggest new features or improvements.
|
| 7 |
+
- **Pull Requests**: Follow the PR template and ensure code quality.
|
| 8 |
+
|
| 9 |
+
Please read our full guidelines before contributing.
|
README.md
CHANGED
|
@@ -1,20 +1,15 @@
|
|
| 1 |
-
-
|
| 2 |
-
title: StudentSuccessHub
|
| 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: Streamlit template space
|
| 12 |
-
license: mit
|
| 13 |
-
---
|
| 14 |
|
| 15 |
-
|
| 16 |
|
| 17 |
-
|
|
|
|
|
|
|
|
|
|
| 18 |
|
| 19 |
-
|
| 20 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# AI-Powered Streamlit App
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
|
| 3 |
+
This is an open-source AI-powered application built with Streamlit.
|
| 4 |
|
| 5 |
+
## Setup Instructions
|
| 6 |
+
1. Clone this repository.
|
| 7 |
+
2. Install dependencies: `pip install -r requirements.txt`
|
| 8 |
+
3. Run the app: `streamlit run app.py`
|
| 9 |
|
| 10 |
+
## Main Features
|
| 11 |
+
- Feature 1
|
| 12 |
+
- Feature 2
|
| 13 |
+
|
| 14 |
+
## Contributing
|
| 15 |
+
See `CONTRIBUTING.md` for guidelines.
|
REPORT.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Project Report
|
| 2 |
+
|
| 3 |
+
## 1. Team Information
|
| 4 |
+
- **Team Name**: [Your Team Name]
|
| 5 |
+
- **Team Members**:
|
| 6 |
+
- Member 1: [Role]
|
| 7 |
+
- Member 2: [Role]
|
| 8 |
+
- Member 3: [Role]
|
| 9 |
+
- Member 4: [Role]
|
| 10 |
+
- Member 5: [Role]
|
| 11 |
+
- **Individual Contributions**:
|
| 12 |
+
- Member 1: [Contribution]
|
| 13 |
+
- Member 2: [Contribution]
|
| 14 |
+
- Member 3: [Contribution]
|
| 15 |
+
- Member 4: [Contribution]
|
| 16 |
+
- Member 5: [Contribution]
|
| 17 |
+
|
| 18 |
+
## 2. Application Overview
|
| 19 |
+
- **Application Name**: [App Name]
|
| 20 |
+
- **Use Case & Problem Solved**: [Description]
|
| 21 |
+
- **Key Features**: [List features]
|
| 22 |
+
- **Motivation**: [Why this use case?]
|
| 23 |
+
|
| 24 |
+
## 3. AI Integration Details
|
| 25 |
+
- **AI Model/Technique Used**: [Model details and links]
|
| 26 |
+
- **How AI Powers the Application**: [Explanation]
|
| 27 |
+
- **Prompt Engineering (if applicable)**: [Strategy and justification]
|
| 28 |
+
|
| 29 |
+
## 4. Technical Architecture & Development
|
| 30 |
+
- **Overall Architecture Diagram**: [Link to diagram]
|
| 31 |
+
- **Technology Stack**: [List technologies]
|
| 32 |
+
- **Challenges & Solutions**: [Describe 3 challenges and solutions]
|
| 33 |
+
- **Open-Source Licensing**: [License and reason]
|
| 34 |
+
|
| 35 |
+
## 5. User Testing & Feedback
|
| 36 |
+
- **Methodology**: [How feedback was gathered]
|
| 37 |
+
- **Summary of Feedback**: [Feedback from 10 users]
|
| 38 |
+
- **Insights & Iterations**: [Changes based on feedback]
|
| 39 |
+
|
| 40 |
+
## 6. Future Roadmap & User Adoption Plan
|
| 41 |
+
- **Future Roadmap**:
|
| 42 |
+
- **Phase 1 (Weeks 1-2)**: [Bug fixes, UI enhancements]
|
| 43 |
+
- **Phase 2 (Weeks 3-4)**: [New feature]
|
| 44 |
+
- **Phase 3 (Weeks 5-6)**: [Additional capabilities]
|
| 45 |
+
- **User Adoption Plan**:
|
| 46 |
+
- **Target Audience Identification**: [Who and where]
|
| 47 |
+
- **Compelling Value Proposition**: [Unique value]
|
| 48 |
+
- **Strategic Promotion**: [Community engagement, content, showcases]
|
| 49 |
+
- **Frictionless Onboarding**: [Ease of use]
|
| 50 |
+
- **Feedback & Iteration Loop**: [Encouraging feedback]
|
| 51 |
+
- **Open-Source Engagement**: [Contribution guidelines]
|
| 52 |
+
|
| 53 |
+
## Links
|
| 54 |
+
- **Code Repository**: [Link to code.swecha.org]
|
| 55 |
+
- **Live Application**: [Link to Hugging Face Space]
|
| 56 |
+
- **Demo Video**: [Link to video]
|
app.py
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import streamlit as st
|
| 2 |
+
|
| 3 |
+
# Page Configuration
|
| 4 |
+
st.set_page_config(
|
| 5 |
+
page_title="Student Success Hub",
|
| 6 |
+
page_icon="🎓",
|
| 7 |
+
layout="wide",
|
| 8 |
+
initial_sidebar_state="expanded"
|
| 9 |
+
)
|
| 10 |
+
|
| 11 |
+
st.title("🎓 Welcome to the Student Success Hub!")
|
| 12 |
+
|
| 13 |
+
st.sidebar.success("Select a tool from the sidebar.")
|
| 14 |
+
|
| 15 |
+
st.markdown(
|
| 16 |
+
"""
|
| 17 |
+
This application is designed to assist students with various academic and productivity tasks.
|
| 18 |
+
Navigate through the tools using the sidebar on the left.
|
| 19 |
+
|
| 20 |
+
**Our Mission:**
|
| 21 |
+
To provide a suite of easy-to-use and effective tools that help you study smarter,
|
| 22 |
+
stay organized, and achieve your academic goals.
|
| 23 |
+
|
| 24 |
+
**What's Inside?**
|
| 25 |
+
Explore the sidebar to discover tools for:
|
| 26 |
+
* Note-taking
|
| 27 |
+
* Task management
|
| 28 |
+
* Study aids
|
| 29 |
+
* And more AI-powered features coming soon!
|
| 30 |
+
|
| 31 |
+
We are continuously working on adding new features.
|
| 32 |
+
If you have any suggestions or feedback, we'd love to hear from you!
|
| 33 |
+
"""
|
| 34 |
+
)
|
| 35 |
+
|
| 36 |
+
st.subheader("Getting Started")
|
| 37 |
+
st.info(
|
| 38 |
+
"""
|
| 39 |
+
1. **Explore:** Check out the tools available in the sidebar.
|
| 40 |
+
2. **Utilize:** Integrate these tools into your daily study routine.
|
| 41 |
+
3. **Feedback:** Let us know how we can make this platform even better for you!
|
| 42 |
+
"""
|
| 43 |
+
)
|
| 44 |
+
|
| 45 |
+
st.caption("Happy studying! Let's make learning more productive and fun. ✨")
|
requirements.txt
CHANGED
|
@@ -1,3 +1,6 @@
|
|
| 1 |
-
|
|
|
|
|
|
|
| 2 |
pandas
|
| 3 |
-
|
|
|
|
|
|
| 1 |
+
streamlit==1.35.0
|
| 2 |
+
# Add other dependencies as needed
|
| 3 |
+
|
| 4 |
pandas
|
| 5 |
+
openai
|
| 6 |
+
transformers
|