SUPRE ASSISTANT app

Overview

An intelligent application designed to help users manage their time and schedules through natural language interaction with an AI assistant.

Core Features

User Data Management

• Events: Create, Read, Update, Delete
• Notes: Create, Read, Update, Delete

AI Assistant

• Natural language chat interface
• Personalized 1:1 AI chatbot per user
• Contextual memory of user's events, notes, and chat history // DONE, with raw RAG, maybe VectorDB later
• Powered by Large Language Model APIs
• Implements Retrieval Augmented Generation (RAG) // DONE with raw RAG, maybe VectorDB later
• JSON Structure for AI responses and smooth integration with backend

Installation

1. Install dependencies

   npm install

2. Build and start the backend

   npm run backend:build
   npm run backend:start

3. Start the mobile app NOTE: The mobile app is managed as a separate project due to compatibility issues between @babel/runtime and iOS simulator. While dependencies are managed independently in the mobile folder, you can still execute mobile app commands from the root workspace.

   First, start the Metro bundler:

   npm run mobile:start

   Then, for iOS:

   npm run mobile:ios

   Or for Android:

   npm run mobile:android

   Before running ios, you need to install pods:

   cd supreassistant_mobile/ios
   pod install

4. BackendDevelopment mode Backend development:

   npm run backend:dev

Docker Deployment

1. Build the Docker image

   docker build -t supre-assistant.

2. Run the Docker container

   docker run -d -p 3000:3000 --env-file .env supre-assistant

License

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

Environment Setup

1. Copy .env.example to create your own .env file:

   cp .env.example .env

2. Update the .env file with your actual values:

   • Generate a secure JWT_SECRET
   • Add your AI provider API keys
   • Configure other environment-specific values

3. Never commit the .env file to version control