Skip to content

JoyceAcacioPedro/RevisAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

RevisIA – Smart Study Assistant

1. Overview

Target Audience: University, high school, and prep students
Objective: Help users review study content intelligently and automatically, combining summaries, quizzes, flashcards, and guided explanations.


2. Main Features (MVP – Initial Version)

2.1 User Registration & Login

  • Login with email and password
  • Login with Google / Facebook
  • Password recovery
  • Personal dashboard

2.2 Create Courses & Subjects

  • Users create courses (e.g., Mathematics, History, Physics)
  • Inside each course, they add subjects or topics (e.g., “Trigonometry”, “French Revolution”)
  • Each subject accepts text, PDFs, or manually typed summaries

2.3 Automatic Organization (AI)

The AI reads the content and:

  • Creates automatic summaries
  • Generates multiple-choice quizzes
  • Generates flashcards (question-answer)
  • Creates a daily study plan (review → quiz → flashcards → guided explanation)

2.4 Study Routine

Each day the user has a task:

  • Day 1: Review content (AI-generated summary)
  • Day 2: Take the quiz
  • Day 3: Flashcards
  • Day 4: Reverse explanation (AI asks questions, user explains)

The system automatically controls the sequence.

2.5 Progress Tracking

  • Shows quiz performance
  • Shows percentage of completed review
  • Generates weekly reports

3. System Architecture

Layer Suggested Tech Description
Frontend React.js / Next.js + Tailwind CSS Modern, responsive, fast interface
Backend (API) Django REST Framework (Python) Handles login, user data, and study logic
Database PostgreSQL or SQLite Stores users, subjects, revisions, and results
AI / NLP OpenAI API / HuggingFace Transformers Generates summaries, quizzes, and flashcards
Authentication JWT / Firebase Auth Security and simplified login
Hosting Vercel (frontend) + Render / AWS (backend) Easy to scale and manage
File Storage Firebase Storage / AWS S3 Stores PDFs, text, and images uploaded by users

4. Database Structure (simplified)

Main tables:

  • Usuario: id, name, email, password, subscription_plan
  • Disciplina: id, name, user_id
  • Materia: id, name, content, discipline_id
  • Atividade: id, type, date, status, subject_id
  • ResultadoQuiz: id, user_id, subject_id, score

5. AI Integration

The AI should provide these functions:

  1. generate_summary(text) → creates a summary
  2. generate_quiz(text) → generates 5–10 multiple-choice questions
  3. generate_flashcards(text) → generates question-answer pairs
  4. generate_study_plan(subjects) → generates a weekly plan

Initially, these functions can use OpenAI API (e.g., GPT-4 or GPT-5-turbo).


6. Development Phases

Phase 1 – MVP (2–3 months)

  • User login and registration
  • Personal dashboard
  • Create courses and subjects
  • AI generates summary and quiz
  • Simple review interface
  • Database working

Phase 2 – Enhancement (3–6 months)

  • Flashcards and reverse explanation
  • Progress and statistics system
  • Modern, responsive design
  • Adaptive study plan

Phase 3 – Scaling & Commercialization

  • Paid subscriptions (Stripe / PayPal)
  • Marketing (landing page + ads)
  • Mobile version (React Native)
  • Community for users

7. Estimated Costs

  • Initial hosting: $10–$20/month
  • AI API (OpenAI): $30–$50/month depending on usage
  • Domain + email: $15/year
  • Initial ads: $100–$200 for testing

8. Differentiators

  • AI personalized per course
  • Guided interface (not just content)
  • Mix of proven methods: spaced repetition + active recall + testing effect
  • Focus on Lusophone students (rare in the market)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors