StudyBuddy Connect is a hybrid learning platform that integrates AI-driven academic support with peer-to-peer tutoring. This initiative aims to bridge the educational gap for students from under-resourced backgrounds by providing both AI-powered assistance and human tutoring.
- AI Study Buddy: Get instant help from our AI tutor
- Peer Tutor Matching: Connect with volunteer tutors
- Q&A Forum: Ask questions and get help from the community
- Progress Tracking: Monitor your learning progress and streaks
- Achievement System: Earn rewards for consistent learning
- Frontend: React.js with Chakra UI
- Backend: Firebase Functions
- Database: Firebase Firestore
- AI: OpenAI API / Gemini
- Authentication: Firebase Auth
- Node.js (v14 or higher)
- npm or yarn
- Firebase account
- OpenAI API key (for AI features)
- Clone the repository:
git clone https://github.com/yourusername/studybuddy-connect.git
cd studybuddy-connect- Install dependencies:
npm install
# or
yarn install- Create a
.envfile in the root directory and add your environment variables:
REACT_APP_FIREBASE_API_KEY=your_firebase_api_key
REACT_APP_FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
REACT_APP_FIREBASE_PROJECT_ID=your_firebase_project_id
REACT_APP_FIREBASE_STORAGE_BUCKET=your_firebase_storage_bucket
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your_firebase_messaging_sender_id
REACT_APP_FIREBASE_APP_ID=your_firebase_app_id
REACT_APP_OPENAI_API_KEY=your_openai_api_key
- Start the development server:
npm start
# or
yarn startThe application will be available at http://localhost:3000
src/
├── components/ # Reusable UI components
├── pages/ # Page components
├── services/ # API and Firebase services
├── utils/ # Utility functions
├── App.js # Main application component
└── index.js # Application entry point
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- Chakra UI for the component library
- Firebase for backend services
- Gemini for AI capabilities