Skip to content

GEET3001/MemoryPal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

MemoryPal - Your Digital Second Brain

MemoryPal is a premium, distraction-free laboratory for your thoughts. Capture notes, curate links, and chat with your personal AI companion—all in one place.

Key Features

  • Personal AI Assistant: Every note gets its own AI companion that understands its specific context.
  • Distraction-Free Editor: A split-pane "Laboratory" layout for writing and brainstorming.
  • Secure Sharing: One-click sharing with protected, authenticated-only access.
  • Context Isolation: AI chats are isolated per note, ensuring your data remains private and relevant.
  • Modern Tech: Built with React, TypeScript, and Google's Gemini 2.0.

Application Workflows

1. User Journey Flow

graph TD
    A[Unauthenticated User] --> B{Sign Up / Sign In}
    B -->|Success| C[Dashboard]
    C --> D[Create New Note]
    C --> E[View Existing Notes]
    E --> F[Open Laboratory Workspace]
    F --> G[Edit Content]
    F --> H[Chat with AI Assistant]
    F --> I[Share Note]
Loading

2. AI Chat Architecture

sequenceDiagram
    participant User
    participant Frontend
    participant Backend
    participant Gemini_AI
    participant MongoDB

    User->>Frontend: Sends message
    Frontend->>Backend: POST /chat (with Context ID)
    Backend->>MongoDB: Fetch Note Context & Chat History
    MongoDB-->>Backend: Returns context
    Backend->>Gemini_AI: Sends context + prompt
    Gemini_AI-->>Backend: Returns AI Response
    Backend->>MongoDB: Save User/AI Messages
    Backend-->>Frontend: Send response
    Frontend-->>User: Display AI text
Loading

3. Secure Note Sharing

graph LR
    A[Owner Note] --> B[Click Share]
    B --> C[Generate Share Hash]
    C --> D[Copy Link to Clipboard]
    D --> E[Public User Clicks Link]
    E --> F{Is User Signed In?}
    F -->|Yes| G[View Protected Note]
    F -->|No| H[Redirect to Sign In]
Loading

Tech Stack

Frontend

  • React + Vite: High-performance UI.
  • Tailwind CSS: Premium minimalist styling.
  • Axios: Secure API communication.

Backend

  • Node.js & Express: Scalable server architecture.
  • TypeScript: End-to-end type safety.
  • MongoDB + Mongoose: Real-time document storage.
  • Gemini 2.0 Flash: State-of-the-art AI integration.

Deployment Guide

Backend (Railway/Render)

  1. Set MONGO_URL, JWT_PASSWORD, and GEMINI_API_KEY in environment variables.
  2. Ensure PORT is exposed.

Frontend (Vercel)

  1. Update BACKEND_URL in src/config.ts.
  2. Run npm run build and deploy the dist folder.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors