docs: update README to reflect pnpm and TypeScript

- Update tech stack section
- Replace npm commands with pnpm
- Add type-check script usage
- Add model configuration feature note
This commit is contained in:
2026-02-26 01:35:55 +01:00
parent 7928fc1f00
commit 2b1838b0eb
+13 -8
View File
@@ -9,14 +9,16 @@ A lightweight Android chat application built with React and Capacitor for connec
- **Dark Theme**: Sleek black/dark UI design
- **Conversation Export**: Save chats as text, log, or markdown files
- **Custom System Prompts**: Inject your own system prompts for personalized interactions
- **Model Configuration**: Custom model name support for local LLMs
- **Offline Ready**: Capacitor wrapper for native Android APK generation
## Tech Stack
- **Frontend**: React (Web)
- **Frontend**: React + TypeScript
- **Mobile Wrapper**: Capacitor
- **Build Tool**: Vite (recommended) or Create React App
- **Testing**: Jest / React Testing Library
- **Build Tool**: Vite
- **Package Manager**: pnpm
- **Testing**: Vitest + React Testing Library
- **Android Studio**: For final APK generation
## Getting Started
@@ -24,25 +26,28 @@ A lightweight Android chat application built with React and Capacitor for connec
### Prerequisites
- Node.js (v18+)
- npm or yarn
- pnpm
- Android Studio (for APK building)
- Capacitor CLI
### Installation
```bash
# Install dependencies
npm install
# Install dependencies with pnpm
pnpm install
# Start development server
npm run dev
pnpm dev
```
### Build for Android
```bash
# Type check TypeScript code
pnpm type-check
# Build the web app
npm run build
pnpm build
# Sync with Capacitor
npx cap sync