An AI-powered learning platform that uses spaced repetition to help you remember information better

• About
• Tech Stack
• Quick Start
• Documentation
• Project Structure
• Available Commands
• Features
• Deployment
• Contributing
• License

Neuros is a cutting-edge learning platform that leverages AI to transform how you retain and recall information through scientifically-proven spaced repetition and active recall techniques.

Live Demo: https://neuros.newth.ai

• AI-Powered Card Generation: Transform any text into structured learning cards using OpenAI GPT-4
• Spaced Repetition: Evidence-based learning algorithm for optimal retention
• User Authentication: Secure sign-up/sign-in with Supabase Auth
• Progress Tracking: Monitor your learning progress with an intuitive dashboard
• Modern UI: Clean, responsive interface built with Tailwind CSS v4
• Mobile-First: Optimized for all devices and screen sizes

Seamlessly integrate with your existing tech stack:

• Node.js 18+
• npm/yarn/pnpm package manager
• Supabase CLI (npm i -g supabase)

# Clone the repository
git clone https://github.com/n3wth/neuros.git
cd neuros

# Install dependencies
npm install

Create a .env.local file in the root directory:

# Supabase Configuration
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
SUPABASE_SERVICE_ROLE_KEY=your_service_role_key

# OpenAI Configuration
OPENAI_API_KEY=your_openai_api_key

# Start local Supabase instance
npm run db:start

# Reset database and apply migrations
npm run db:reset

# Generate TypeScript types from schema
npm run db:types

npm run dev

Open http://localhost:3000 in your browser!

All project documentation is organized in the docs/ folder:

Complete Documentation: See docs/README.md for the full index.

neuros/
├── app/                    # Next.js App Router
│   ├── (auth)/             # Authentication routes
│   ├── (dashboard)/        # Protected dashboard
│   └── (public)/           # Public pages
├── components/            
│   ├── ui/                 # Reusable UI components
│   ├── features/           # Feature-specific components
│   ├── learning/           # Learning functionality
│   └── landing/            # Landing page components
├── docs/                   # Project documentation
├── scripts/                # Automation & utilities
├── server/
│   ├── actions/            # Server Actions
│   └── queries/            # Database queries
├── supabase/
│   └── migrations/         # Database schema
└── types/                  # TypeScript definitions

npm run dev              # Start development server
npm run build           # Production build
npm run start           # Start production server
npm run lint            # Run ESLint
npm run typecheck       # TypeScript checking

npm run db:start        # Start local Supabase
npm run db:stop         # Stop local Supabase
npm run db:reset        # Reset & apply migrations
npm run db:types        # Generate TypeScript types

npm run test            # Run unit tests once
npm run test:watch      # Run unit tests in watch mode
npm run test:ui         # Interactive test UI
npm run test:coverage   # Coverage report
npm run test:e2e        # End-to-end tests

• Authentication: Complete user management (sign up, sign in, password reset)
• AI Card Generation: Transform any text into structured learning cards
• Spaced Repetition: Evidence-based algorithm for optimal retention
• Dashboard: Comprehensive learning progress tracking
• Review Interface: Intuitive card review system
• Responsive Design: Mobile-first, cross-device compatibility
• Theme Support: Dark/light mode with smooth transitions
• Security: Rate limiting, input validation, secure authentication

• Advanced Analytics: Detailed learning insights and metrics
• Collaborative Learning: Team-based learning features
• Enhanced AI: More sophisticated content generation and personalization
• Mobile App: Native mobile application
• API Integration: Third-party learning platform connections

One-click deployment:

1. Fork this repository
2. Connect to Vercel
3. Add environment variables
4. Deploy!

# Build for production
npm run build

# Start production server
npm run start

• 📖 Deployment Guide
• 🎭 Playwright Setup
• 🧪 Testing Coverage
• ⚡ Rate Limiting

We welcome contributions! Here's how to get started:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

• Follow existing code style and patterns
• Add tests for new features
• Update documentation as needed
• Ensure all tests pass before submitting

This project is licensed under the MIT License - see the LICENSE file for details.

🧠 Built with ❤️ by Oliver Newth

Empowering learners worldwide with AI-driven education technology 🚀