Skip to content

Your AI-powered personalized study companion built using Python, NLP, and speech tools.

License

Notifications You must be signed in to change notification settings

rakesh-k05/SmartStudyBot

 
 

Repository files navigation

Crewjah Banner

Crewjah Badge

Crewjah

Your AI-powered, privacy-first study companion. Summarize notes, quiz yourself, plan, and track progress—all in one open source app.

GitHub contributors PRs Welcome


Features

  • AI Q&A: Ask anything, get instant answers with references
  • Summarize Text & Code: Turn long content or code into key points
  • Quiz & Flashcards: Practice, spaced repetition, and track retention
  • Study Planner: Add tasks, calendar view, streaks
  • Progress Tracker: Charts for study time, quizzes, flashcards, streaks
  • Resource Finder: Curated links by topic, save for later
  • Accessibility: Dark mode, font size, keyboard shortcuts, privacy-first analytics
  • Privacy: No ads, no data selling, export/delete your data
  • Modern UI: Next.js (React), FastAPI backend, SQLite/SQLAlchemy

Tech Stack


Getting Started

Clone this repository and install dependencies for both frontend and backend:

# Clone the repo
git clone https://github.com/imDarshanGK/Crewjah.git
cd Crewjah

# Backend setup
pip install -r requirements.txt

# Frontend setup
cd Crewjah
npm install

Run the app locally

# In one terminal (API backend)
uvicorn api.main:app --reload

# In another terminal (Frontend)
cd Crewjah
npm run dev

Project Structure

Crewjah/
├── api/                # FastAPI backend
│   ├── main.py         # API endpoints
│   ├── models.py       # SQLAlchemy models
│   ├── db.py           # DB session
│   └── alembic/        # Migrations
├── Crewjah/            # Next.js frontend
│   ├── app/            # All pages (dashboard, quiz, flashcards, etc.)
│   ├── components/     # Shared UI components
│   └── public/         # Static assets
├── modules/            # Python modules (summarize, TTS, etc.)
├── data/               # User data, questions, progress
├── assets/             # Images, banners, logos
├── tests/              # Tests
└── README.md

Contributing

We ❤️ contributions from the community!


License

This project is licensed under the MIT License.


Looking for Contributors

We welcome beginner-friendly contributions!

⭐ Star the repo and check the issues to get started.

About

Your AI-powered personalized study companion built using Python, NLP, and speech tools.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 71.5%
  • Python 26.3%
  • CSS 2.0%
  • JavaScript 0.2%