Studyrix is a standalone study materials browser powered by community‑maintained Google Drive resources. It is built for fast, read‑only access, with offline support, tagging, and search for students.
- A Next.js App Router application for browsing study materials.
- Read‑only Supabase access to course metadata.
- Google Drive integration for folder/file listings and file downloads.
- Local preferences and offline storage (IndexedDB and optional device folder).
- Install dependencies.
npm install- Create a local environment file.
cp .env.local.example .env.local- Fill required environment variables.
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
GOOGLE_DRIVE_API_KEY=- Run the dev server.
npm run devOpen http://localhost:3000.
npm run devStart the dev servernpm run buildProduction buildnpm run startStart the production servernpm run lintRun ESLint
Required:
NEXT_PUBLIC_SUPABASE_URLSupabase project URLNEXT_PUBLIC_SUPABASE_ANON_KEYPublic anon key (read‑only)GOOGLE_DRIVE_API_KEYGoogle Drive API key
Notes:
- No service‑role keys are used.
- The Google Drive key must be restricted by HTTP referrer and limited to the Drive API in GCP.
- Study materials only
- Read‑only access
- No authentication
- Local preferences stored in IndexedDB (with localStorage fallback)
- Department + semester onboarding
- Course browsing with Drive‑backed folders
- Search and MIME filtering
- Favorites and tags
- Offline saving with cache limits
- Optional device folder mode for offline files
- Architecture:
ARCHITECTURE.md - API routes:
API_ROUTES.md - Security policy:
SECURITY.md - Contributing:
CONTRIBUTING.md - App routes:
ROUTES.md - Data models:
DATA_MODELS.md - Design system:
DESIGN_SYSTEM.md - Feature summary:
FEATURES.md
See DEPLOYMENT.md for production setup and recommendations.
License is not currently defined in this repository. Add a LICENSE file before public release.
Studyrix is powered by Attendrix and maintained by Team Attendrix.