AI-Powered Study Sessions Platform
Transform your learning experience with Studorama, an intelligent study platform that generates personalized questions and provides AI-driven feedback to enhance your understanding of any subject.
- Multiple Choice Questions: Quick assessment with 4 options and detailed explanations
- Dissertative Questions: Open-ended questions for deep analysis and critical thinking
- Customizable AI Prompts: Tailor the AI's behavior to your learning style
- Progress Tracking: Monitor your learning journey with detailed analytics
- Session History: Review past sessions with comprehensive question-by-question breakdowns
- Adaptive Scoring: Intelligent evaluation of both multiple choice and essay answers
- Subject Flexibility: Study any topic from JavaScript to World History
- Custom Prompts: Modify AI prompts to match your preferred learning approach
- Intelligent Feedback: Get constructive, encouraging feedback on all answers
- Local Storage: All data stays in your browser - complete privacy guaranteed
- Secure API Integration: Your OpenAI API key is stored locally and never shared
- No Account Required: Start studying immediately without registration
- Modern web browser (Chrome, Firefox, Safari, Edge)
- OpenAI API key (Get one here)
-
Clone the repository
git clone https://github.com/oluiscabral/studorama.git cd studorama -
Install dependencies
npm install
-
Start the development server
npm run dev
-
Configure your API key
- Open the application in your browser
- Navigate to Settings
- Enter your OpenAI API key
- Select your preferred model
-
Start studying!
- Choose a subject
- Select question type (Multiple Choice or Dissertative)
- Begin your AI-powered study session
- Frontend: React 18 with TypeScript
- Styling: Tailwind CSS
- Icons: Lucide React
- Routing: React Router DOM
- AI Integration: OpenAI API
- Build Tool: Vite
- Storage: Browser Local Storage
Studorama is fully responsive and works seamlessly across:
- 📱 Mobile devices
- 📱 Tablets
- 💻 Desktop computers
- 🖥️ Large screens
- Clean, modern design inspired by leading educational platforms
- Smooth animations and micro-interactions
- Accessible color scheme with proper contrast ratios
- Progressive disclosure to manage complexity
- Auto-save: Sessions are automatically saved as you progress
- Continue Sessions: Resume incomplete study sessions anytime
- Detailed Analytics: Track your improvement over time
- Export Ready: Session data can be easily exported for external analysis
- GPT-4o (Recommended)
- GPT-4o Mini (Cost-effective)
- GPT-4 Turbo
- GPT-4
- GPT-3.5 Turbo
Modify how the AI generates and evaluates questions:
- Multiple Choice Prompt: Customize question generation style
- Dissertative Prompt: Tailor essay question complexity
- Evaluation Prompt: Adjust feedback tone and criteria
Studorama is optimized for search engines with:
- Comprehensive meta tags
- Open Graph integration
- Twitter Card support
- Structured data markup
- Semantic HTML structure
Studorama includes an automated versioning system that increments version numbers on deployment:
# Bump patch version (bug fixes)
npm run version:patch
# Bump minor version (new features)
npm run version:minor
# Bump major version (breaking changes)
npm run version:major
# Check current version
npm run version:info# Deploy with patch version bump
npm run deploy
# Deploy with minor version bump
npm run deploy:minor
# Deploy with major version bump
npm run deploy:majorThe deployment script automatically:
- Runs pre-deployment checks
- Bumps the version number
- Updates all relevant files (package.json, .env, index.html, service worker)
- Creates a git tag
- Builds the application
- Pushes changes to the repository
package.json- Main version field.env- APP_VERSION environment variableindex.html- Structured data softwareVersionpublic/sw.js- Service worker cache namespublic/version.json- Build information
# Development server
npm run dev
# Production build
npm run build
# Preview production build
npm run preview
# Lint code
npm run lintWe welcome contributions! Here's how you can help:
- Fork the repository
- Create a feature branch
git checkout -b feature/amazing-feature
- Commit your changes
git commit -m 'Add amazing feature' - Push to the branch
git push origin feature/amazing-feature
- Open a Pull Request
- Follow TypeScript best practices
- Maintain responsive design principles
- Write clear, descriptive commit messages
- Test across multiple browsers
- Ensure accessibility compliance
- Use the automated versioning system for releases
This project is licensed under the MIT License - see the LICENSE file for details.
oluiscabral
- 🐙 GitHub: @oluiscabral
- 💼 LinkedIn: oluiscabral
- 🌐 Portfolio: [Coming Soon]
- OpenAI for providing the powerful GPT models
- The React community for excellent documentation and tools
- Tailwind CSS for the utility-first CSS framework
- Lucide for the beautiful icon set
- Study Groups: Collaborative learning sessions
- Spaced Repetition: Intelligent review scheduling
- Performance Analytics: Advanced progress tracking
- Export Options: PDF and CSV export capabilities
- Offline Mode: Study without internet connection
- Mobile App: Native iOS and Android applications
- Integration with popular learning management systems
- AI-powered study plan generation
- Gamification elements and achievements
- Multi-language support
- Voice-to-text answer input
Having issues or questions? We're here to help!
- 🐛 Bug Reports: Open an issue
- 💡 Feature Requests: Start a discussion
- 📧 Direct Contact: LinkedIn
If Studorama helps you learn better, please consider:
- ⭐ Starring the repository
- 🐦 Sharing on social media
- 🤝 Contributing to the project
- 📝 Writing a review or blog post
Made with ❤️ by oluiscabral
Empowering learners worldwide with AI-driven education technology.