feat: Revamp README with detailed project information and add initial design system documentation.
This commit is contained in:
Evandro Fonseca Junior committed
1 parent
7303d568f4
commit
6ec3445fc7
6 files changed
+2587
-384
No files matched your search
@@ -1,50 +1,79 @@
|
||||
# Welcome to your Expo app 👋
|
||||
# Local AI Companion
|
||||
|
||||
This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
|
||||
   
|
||||
|
||||
## Get started
|
||||
> A fully local, privacy-first AI companion app built with React Native and Expo. Your data never leaves your device.
|
||||
|
||||
1. Install dependencies
|
||||
This application connects directly to your own local AI models, completely offline. Currently in alpha, it pairs flawlessly with the [LMStudio](https://lmstudio.ai) local inference API. We developed and tested it against **Qwen3.5 (without thinking)** to guarantee a smooth, zero-latency experience.
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
*Roadmap: Future updates will introduce direct in-app model downloads and support for external APIs.*
|
||||
|
||||
2. Start the app
|
||||
---
|
||||
|
||||
```bash
|
||||
npx expo start
|
||||
```
|
||||
## Features
|
||||
|
||||
In the output, you'll find options to open the app in a
|
||||
- **100% Offline Inference:** Complete privacy. Zero cloud dependency.
|
||||
- **Plug & Play LMStudio:** Instantly detects and fetches active models from your local server.
|
||||
- **Persistent Sessions:** Chat histories and settings are saved locally using Zustand and `AsyncStorage`.
|
||||
- **Developer-Friendly UI:** Real-time markdown rendering with syntax highlighting and 1-click code copying.
|
||||
- **Minimalist Dark Mode:** High-contrast, distraction-free interface built on NativeWind principles.
|
||||
|
||||
- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
|
||||
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
|
||||
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
|
||||
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
|
||||
---
|
||||
|
||||
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
|
||||
## Quick Start
|
||||
|
||||
## Get a fresh project
|
||||
To run this application, you will need both the frontend development environment and a local AI engine running.
|
||||
|
||||
When you're ready, run:
|
||||
### 1. Model Server (LMStudio)
|
||||
|
||||
1. Extract and open [LMStudio](https://lmstudio.ai/).
|
||||
2. Download a compatible model (e.g., Llama 3, Qwen2.5, Mistral).
|
||||
3. Open the **Local Server** tab (`<->`).
|
||||
4. Enable **CORS** and set the port (default: `1234`).
|
||||
5. Click **Start Server**.
|
||||
|
||||
> **Note:** If testing on a physical mobile device, locate your machine's local IPv4 address (e.g., `192.168.1.X`).
|
||||
|
||||
### 2. Mobile Client (App)
|
||||
|
||||
Ensure you have [Node.js](https://nodejs.org/) (v18+) and the [Expo Go](https://expo.dev/go) app installed.
|
||||
|
||||
```bash
|
||||
npm run reset-project
|
||||
git clone https://github.com/evandrodevbr/LocalAiApp.git
|
||||
cd LocalAiApp
|
||||
npm install
|
||||
npx expo start
|
||||
```
|
||||
|
||||
This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
|
||||
Scan the QR code with Expo Go, or type `i`/`a` to launch a simulator.
|
||||
|
||||
## Learn more
|
||||
### 3. Connection
|
||||
|
||||
To learn more about developing your project with Expo, look at the following resources:
|
||||
1. Open the app and tap the **Settings** icon.
|
||||
2. Enter your LMStudio server IP and Port (e.g., `192.168.1.X:1234`).
|
||||
3. Tap **Test Connection**.
|
||||
|
||||
- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
|
||||
- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.
|
||||
Once connected, your available models will load automatically.
|
||||
|
||||
## Join the community
|
||||
---
|
||||
|
||||
Join our community of developers creating universal apps.
|
||||
## Bug Reports & Contributing
|
||||
|
||||
- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute.
|
||||
- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions.
|
||||
Found an issue or have a suggestion? We welcome community involvement!
|
||||
|
||||
👉 **[Report an Issue or Request a Feature](https://github.com/evandrodevbr/LocalAiApp/issues)**
|
||||
|
||||
When creating an issue, please include:
|
||||
|
||||
- A clear description of the bug.
|
||||
- Steps to reproduce.
|
||||
- Relevant screenshots or environment details.
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
Thank you for exploring this project! Our mission is to share knowledge and foster an open-source collaborative ecosystem around offline AI solutions. All feedback, testing, and code contributions are highly appreciated.
|
||||
|
||||
<br>
|
||||
<br>
|
||||
Reference in new issue
Block a user