d-ragon commited on
Commit
779b280
·
verified ·
1 Parent(s): 69ce6ff

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -109
README.md CHANGED
@@ -2,112 +2,3 @@
2
  title: Vector
3
  sdk: docker
4
  ---
5
- # Vector AI 🚀
6
-
7
- Vector AI is a premium, self-hosted AI workspace that combines the conversational power of ChatGPT with the research capabilities of Perplexity. Built on top of **Flowise**, it provides a stunning, high-performance interface for both casual chat and professional document development.
8
-
9
- ![Vector AI Preview](https://img.shields.io/badge/Status-Active-brightgreen)
10
- ![Framework](https://img.shields.io/badge/Framework-React-blue)
11
- ![Backend](https://img.shields.io/badge/Backend-Node.js-66cc33)
12
- ![AI-Powered](https://img.shields.io/badge/Powered%20By-Flowise-orange)
13
-
14
- ---
15
-
16
- ## ✨ Key Features
17
-
18
- ### 💬 Advanced Chat Interface
19
- - **SSE Streaming**: Ultra-fast, real-time response streaming for a seamless experience.
20
- - **Live Activity Indicators**: See exactly what the AI is doing—whether it's "Thinking", "Searching", or using specific tools.
21
- - **LaTeX & KaTeX**: Full support for mathematical equations, fractions, and scientific notation with beautiful rendering.
22
- - **File Uploads**: Support for processing PDF and text files directly within the chat.
23
- - **Speech-to-Text**: Built-in voice input for hands-free interaction.
24
-
25
- ### 🧪 Vector Labs (Workspaces)
26
- - **Project-Based Editing**: Create and manage long-form documents in dedicated workspaces.
27
- - **Surgical AI Edits**: Highlight specific sections of your text and have the AI refine just that selection.
28
- - **Persistent State**: Projects are saved locally and persist through page refreshes and sessions.
29
- - **Global Context**: The AI understands the full document while you edit, ensuring consistency.
30
-
31
- ### 📄 Export & Integration
32
- - **Modern Word Export**: Export your documents to `.docx` with clean, modern typography (Arial/Inter style).
33
- - **PDF Generation**: Quick PDF exports for sharing your work.
34
- - **Model Selector**: Easily switch between different Flowise Chatflows for specialized tasks.
35
-
36
- ---
37
-
38
- ## 🚀 Quick Start
39
-
40
- ### 1. Prerequisites
41
- - **Node.js** (v18 or higher)
42
- - A running **Flowise** instance (local, HF Spaces, or Railway)
43
-
44
- ### 2. Installation
45
- ```bash
46
- # Clone the repository
47
- git clone https://github.com/your-repo/vector-ai.git
48
- cd vector-ai
49
-
50
- # Install dependencies
51
- npm install
52
- ```
53
-
54
- ### 3. Configuration
55
- Create a `.env` file in the root directory:
56
-
57
- ```env
58
- PORT=3000
59
-
60
- # Primary Chat Models
61
- MODEL_1_NAME="Vector GPT"
62
- MODEL_1_ID="YOUR_CHATFLOW_ID_1"
63
- MODEL_1_HOST="https://your-flowise.hf.space"
64
-
65
- MODEL_2_NAME="Vector Research"
66
- MODEL_2_ID="YOUR_CHATFLOW_ID_2"
67
- MODEL_2_HOST="https://your-flowise.hf.space"
68
-
69
- # Dedicated Labs Model (Optional - falls back to Model 1)
70
- LABS_MODEL_NAME="Vector Editor"
71
- LABS_MODEL_ID="YOUR_LABS_CHATFLOW_ID"
72
- LABS_MODEL_HOST="https://your-flowise.hf.space"
73
-
74
- # Optional: Flowise Authentication
75
- # FLOWISE_API_KEY=your_api_key
76
- ```
77
-
78
- ### 4. Development & Build
79
- ```bash
80
- # Run in development mode
81
- npm run dev
82
-
83
- # Build the frontend and run the production server
84
- npm run build
85
- npm start
86
- ```
87
-
88
- ---
89
-
90
- ## 🛠 Tech Stack
91
-
92
- - **Frontend**: [React](https://reactjs.org/) + [Vite](https://vitejs.dev/)
93
- - **Styling**: [Tailwind CSS](https://tailwindcss.com/) + [Framer Motion](https://www.framer.com/motion/)
94
- - **Backend**: [Node.js](https://nodejs.org/) + [Express](https://expressjs.com/)
95
- - **Streaming**: Server-Sent Events (SSE)
96
- - **AI Orchestration**: [Flowise](https://flowiseai.com/)
97
- - **Rich Text**: [React Markdown](https://github.com/remarkjs/react-markdown) + [KaTeX](https://katex.org/)
98
-
99
- ---
100
-
101
- ## ☁️ Deployment
102
-
103
- ### Render / Railway / HF Spaces
104
- This project is designed to be easily deployable as a single service:
105
-
106
- 1. **Build Command**: `npm install && npm run build`
107
- 2. **Start Command**: `npm start`
108
- 3. **Environment Variables**: Add your `MODEL_*` variables in the platform's dashboard.
109
-
110
- ---
111
-
112
- ## 📝 License
113
- This project is licensed under the MIT License.
 
2
  title: Vector
3
  sdk: docker
4
  ---