📚 AI Study Partner

AI Study Partner is an open-source app for students. You upload your study files (PDFs/notes), and it helps you learn step by step.

• Turn your notes into chapters and topics
• Explain topics in easy language
• Create quizzes and mock exams
• Show weak topics for revision
• Save your learning progress

• Students preparing for exams
• Parents and teachers helping students
• Open-source beginners who want to contribute

You need:

• Node.js 18.17+
• One supported AI CLI: claude or codex

1. Install packages:

   npm install

2. Create local environment file:

   cp .env.example .env.local

3. Add this in .env.local:

   COMPANION_SECRET=your-long-random-secret

4. (Optional) Generate a strong secret:

   node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

5. Start the app:

   npm run dev:all

Now open: http://localhost:3000

After opening the app:

1. Go to Settings → AI settings
2. Check companion status
3. Install/sign in to your AI CLI if needed
4. Upload your first study file

1. Upload PDF or notes
2. App creates a course structure
3. Learn topic-by-topic
4. Take quizzes
5. Revise weak areas
6. Track progress

• Your data is stored on your machine in ./data
• ./data is git-ignored
• This app is made for local personal use

Reset local password:

npm run reset-password

Reset specific email:

npm run reset-password [email protected]

Run companion on host:

npm run companion

Then run web app in Docker:

export $(grep -v '^#' .env.local | xargs)
docker compose up --build

Open: http://localhost:3000

1. Fork this repo

2. Create a branch

3. Make your changes

4. Run:

   npm run lint
   npm run test

5. Open a pull request with clear summary

• src/app → pages and API routes
• src/components → UI components
• src/lib → app logic (learn, quiz, store, ingest)
• companion → local AI companion service
• scripts → helper scripts

• npm run dev → start web app
• npm run companion → start companion service
• npm run dev:all → start both together
• npm run lint → lint checks
• npm run test → tests
• npm run build → production build