Skip to content

README.md

Latest commit

 

History

History
80 lines (51 loc) · 1.54 KB

README.md

File metadata and controls

80 lines (51 loc) · 1.54 KB
Raw

DoubtBuddy (JEE AI Study App)

DoubtBuddy helps JEE students solve doubts, practice smarter, revise with spaced repetition, and track progress in one app.

Highlights

  • AI doubt solving with provider orchestration (Gemini-first, fallback-ready)
  • Practice mode with configurable set sizes and grading flows
  • Revision mode with spaced-repetition scheduling
  • Progress dashboard with weak-topic drill-down
  • Offline queue for text solve replay

Tech Stack

  • Expo SDK 55 / React Native 0.83
  • TypeScript
  • AsyncStorage + SecureStore
  • React Navigation

Getting Started

Prerequisites

  • Node.js 20+
  • npm 10+
  • Expo CLI via npx

Install

npm install

Run

npm run start

Then open on device/emulator using Expo Go (or development build).

Quality Checks

npm run typecheck
npm run test:practice
npm run test:offline-queue

Additional test scripts are available in package.json.

App Icon

Replace icon assets under assets/:

  • assets/icon.png
  • optional Android adaptive icon assets if you use split foreground/background

Then run Expo with cache clear:

npx expo start -c

CI/CD (GitHub Actions)

This repo includes:

  • ci.yml for typecheck + test suite on push/PR
  • expo-deploy.yml for optional EAS Update publish on manual trigger

For deploy workflow, configure repository secrets before use:

  • EXPO_TOKEN

Deployment workflow is manual (workflow_dispatch) so no credentials are exposed in code.

License

Apache License 2.0 (you said you’ll add LICENSE manually).