CruxPad is a high-performance, SaaS-style study platform designed specifically for engineering students. By leveraging the power of SambaNova AI and Firebase, CruxPad transforms dense technical material into digestible, interactive learning assets.
Tip
Streamline your revision: Upload your PDFs, generate concept cards, and visualize the logical flow of your subjects in real-time.
| Feature | Description |
|---|---|
| 🔐 Secure Auth | Multi-method login via Firebase (Google & Email/Password). |
| 📄 Smart Parsing | Professional-grade PDF and TXT extraction for engineering documents. |
| 🤖 AI Cheatsheets | Powered by SambaNova's Llama-3.3-70B for precision revision notes. |
| ⚡ Exam Mode | Instant generation of ultra-short summaries, formulas, and key examples. |
| 🕸️ Knowledge Graphs | Interactive visual maps using React Flow to connect complex concepts. |
| 🔗 Public Sharing | Generate secure, permanent links to share your refined notes with peers. |
- Framework: Next.js (App Router, Server Actions)
- Styling: Tailwind CSS
- Database & Auth: Firebase (Firestore + Auth)
- AI Brain: SambaNova Cloud API (Llama-3.1/3.3 models)
- Visualization: React Flow
- PDF Engine:
pdf-parse&pdfjs-dist - UI Icons: Lucide React
CruxPad/
├── app/ # Next.js App Router (Dashboard, Upload, Notes, API)
├── components/ # Reusable UI (CheatCard, GraphView, etc.)
├── lib/ # Shared logic (AI drivers, Parsers, Firestore utils)
├── public/ # Static assets (Brand logos, Favicons)
├── types/ # TypeScript definitions
└── firestore.rules # Firebase security configurations- Node.js (Latest LTS recommended)
- Firebase Project
- SambaNova API Key
git clone https://github.com/Anish-2005/CruxPad.git
cd CruxPad
npm installCreate a .env.local file in the root directory:
SAMBANOVA_API_KEY=your_api_key
SAMBANOVA_BASE_URL=https://api.sambanova.ai/v1
SAMBANOVA_MODEL=Meta-Llama-3.3-70B-Instruct
# Firebase Configuration
NEXT_PUBLIC_FIREBASE_API_KEY=...
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=...
...npm run devNavigate to http://localhost:3000 to see your app in action!
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Please see CONTRIBUTING.md for more details.
Distributed under the MIT License. See LICENSE for more information.
Built with ❤️ for Engineering Students