Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI Knowledge Hub

An AI-powered learning companion for intelligent conversations, knowledge management, and smart flashcards.

Features

  • 🤖 AI Chat: Have intelligent conversations with advanced AI
  • 📚 Knowledge Base: Save and organize important information with auto-generated summaries
  • 🃏 Flashcards: AI-generated flashcards for effective learning
  • 📊 Dashboard: Track your learning progress

Tech Stack

Frontend

  • React 18 + Vite
  • Tailwind CSS
  • Framer Motion
  • Zustand (State Management)
  • React Router DOM

Backend

  • Node.js + Express
  • MongoDB + Mongoose
  • JWT Authentication
  • Groq AI SDK

Deployment (Vercel)

This project is configured for serverless deployment on Vercel.

Environment Variables

Set the following environment variables in your Vercel project settings:

Variable Description
MONGODB_URI MongoDB connection string
JWT_SECRET Secret key for JWT tokens
GROQ_API_KEY API key for Groq AI

Deploy

  1. Push to GitHub
  2. Import project in Vercel
  3. Set environment variables
  4. Deploy

Local Development

Prerequisites

  • Node.js 18+
  • MongoDB (local or Atlas)
  • Groq API Key

Setup

  1. Clone the repository
git clone https://github.com/noahvlone/Randomez.git
cd Randomez
  1. Install dependencies
npm run install:all
  1. Create environment files

backend/.env

MONGODB_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret
GROQ_API_KEY=your_groq_api_key
PORT=5000
  1. Run development servers
npm run dev

Project Structure

├── api/                  # Vercel serverless functions
│   └── index.js          # Main API handler
├── backend/              # Express backend
│   └── src/
│       ├── config/       # Database configuration
│       ├── middleware/   # Auth middleware
│       ├── models/       # Mongoose models
│       ├── routes/       # API routes
│       └── services/     # AI services
├── frontend/             # React frontend
│   └── src/
│       ├── components/   # React components
│       ├── pages/        # Page components
│       ├── services/     # API services
│       └── store/        # Zustand stores
└── vercel.json           # Vercel configuration

License

MIT

About

AI-powered learning companion for intelligent conversations, knowledge management, and smart flashcards.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages