This is the codebase of StudyHub, an innovative educational platform designed to enhance learning and collaboration between students.
View Website
.
Report Bug
·
Request Feature
Table of Contents
Introducing StudyHub: 🚀 Your Academic Launchpad!
In a digital era brimming with possibilities, education should be accessible, engaging, and collaborative. But we know the struggle: reliable academic support can be elusive, leaving growth opportunities untapped. That's why StudyHub emerged, combining the pulse of social media with the finesse of advanced AI tools.
🔮 With AI as its superpower, StudyHub becomes your academic ally. It's not just a platform; it's your bridge to smarter learning.
Why embrace StudyHub? Let's break it down:
-
🤝 Connect and Conquer: Ever felt stuck while studying? StudyHub breaks the ice, connecting you with fellow students who share your quest for knowledge. Collaboration has never been cooler.
-
🌟 AI Magic at Your Service: Say goodbye to one-size-fits-all solutions. StudyHub's AI wizardry tailors its offerings just for you. From automated essay grading to customized concept explanations, it's like having your own virtual tutor, but way cooler.
-
💬 Chatter That Matters: Imagine engaging in academic discussions that light up your neurons. StudyHub's social vibes fuel meaningful conversations, sparking insights you won't find in a textbook.
-
📚 All-Inclusive Academic Oasis: No more frantic browser hopping for resources. StudyHub wraps it all up – academic consultation, resources, and discussions – in a user-friendly package. A one-stop shop for your learning journey.
-
🧠 By Learners, for Learners: We're not just tech enthusiasts; we're learners too. Your feedback is our rocket fuel. StudyHub's user-centric evolution ensures we stay ahead of your learning curve.
Ready to level up your learning game? Say hello to StudyHub, where AI meets education, and collaboration takes the spotlight. Let's learn, connect, and conquer together! 🚀
These instructions will get you a copy of the project up and running on your local machine for development. See deployment for notes on how to deploy the project.
- Python (3.11 Recommended)
- AWS S3 Bucket on Amazon Web Services
- OpenAI API Key
- Pinecone API Key & Index Name
- Clone the repository.
git clone https://github.com/TheTrustyPwo/StudyHub.git- Set up a
venvand usepipto install the project dependencies.
cd StudyHub
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt-
Configure the config.py if necessary.
-
Set the required environment variables and start the app. Now you can give the application a try at http://localhost:5000!
export AWS_ACCESS_KEY=key
export AWS_SECRET_ACCESS_KEY=key
export OPENAI_API_KEY=key
export PINECONE_API_KEY=key
flask runYou can also serve the application using gunicorn.
gunicorn "app:create_app()"Test the application with the custom script.
python test.pyComing Soon
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the GNU GPLv3 License. See LICENSE.txt for more information.
- TheTrustyPwo (Lead) - thepwo ( Discord) - thetrustypwo@gmail.com
- Stucknight
- Starknight45
- broui
Project Link: https://github.com/TheTrustyPwo/StudyHub
The full project report is available here, although some parts have been edited out for privacy reasons.