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:
@@ -9,14 +9,16 @@ A lightweight Android chat application built with React and Capacitor for connec
|
|||||||
- **Dark Theme**: Sleek black/dark UI design
|
- **Dark Theme**: Sleek black/dark UI design
|
||||||
- **Conversation Export**: Save chats as text, log, or markdown files
|
- **Conversation Export**: Save chats as text, log, or markdown files
|
||||||
- **Custom System Prompts**: Inject your own system prompts for personalized interactions
|
- **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
|
- **Offline Ready**: Capacitor wrapper for native Android APK generation
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
- **Frontend**: React (Web)
|
- **Frontend**: React + TypeScript
|
||||||
- **Mobile Wrapper**: Capacitor
|
- **Mobile Wrapper**: Capacitor
|
||||||
- **Build Tool**: Vite (recommended) or Create React App
|
- **Build Tool**: Vite
|
||||||
- **Testing**: Jest / React Testing Library
|
- **Package Manager**: pnpm
|
||||||
|
- **Testing**: Vitest + React Testing Library
|
||||||
- **Android Studio**: For final APK generation
|
- **Android Studio**: For final APK generation
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
@@ -24,25 +26,28 @@ A lightweight Android chat application built with React and Capacitor for connec
|
|||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Node.js (v18+)
|
- Node.js (v18+)
|
||||||
- npm or yarn
|
- pnpm
|
||||||
- Android Studio (for APK building)
|
- Android Studio (for APK building)
|
||||||
- Capacitor CLI
|
- Capacitor CLI
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install dependencies
|
# Install dependencies with pnpm
|
||||||
npm install
|
pnpm install
|
||||||
|
|
||||||
# Start development server
|
# Start development server
|
||||||
npm run dev
|
pnpm dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### Build for Android
|
### Build for Android
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Type check TypeScript code
|
||||||
|
pnpm type-check
|
||||||
|
|
||||||
# Build the web app
|
# Build the web app
|
||||||
npm run build
|
pnpm build
|
||||||
|
|
||||||
# Sync with Capacitor
|
# Sync with Capacitor
|
||||||
npx cap sync
|
npx cap sync
|
||||||
|
|||||||
Reference in New Issue
Block a user