docs: Add comprehensive README for SAPIENS Mobile

- React Native & Expo setup instructions - Project structure overview - Development and build guidelines - API integration documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-23 14:49:55 +09:00
parent 7191799ffa
commit 4caa757850
1 changed files with 101 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,101 @@
+# SAPIENS Mobile
+
+React Native mobile application for the SAPIENS news platform.
+
+## Overview
+
+SAPIENS Mobile is a cross-platform mobile application built with React Native and Expo, providing users with access to curated news content from various outlets with AI-powered features.
+
+## Tech Stack
+
+- **Framework**: React Native 0.81.4 with Expo ~54.0
+- **Language**: TypeScript ~5.9.2
+- **Navigation**: Expo Router ~6.0
+- **Styling**: NativeWind 4.2 (Tailwind CSS for React Native)
+- **State Management**: TanStack React Query ~5.90
+- **UI Components**: Expo symbols, Vector Icons
+
+## Project Structure
+
+```
+sapiens-mobile/
+├── sapiense-ai-app/          # Main Expo application
+│   ├── app/                  # Expo Router pages
+│   ├── components/           # Reusable React components
+│   ├── contexts/             # React contexts
+│   └── lib/                  # Utility functions and API clients
+├── server/                   # Backend server (if applicable)
+├── client/                   # Web client (if applicable)
+└── shared/                   # Shared utilities
+```
+
+## Features
+
+- Cross-platform support (iOS, Android, Web)
+- News outlet browsing
+- Article reading interface
+- Language selection support
+- Responsive design with NativeWind
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js 18+ and npm/yarn
+- Expo CLI
+- iOS Simulator (for iOS development)
+- Android Studio (for Android development)
+
+### Installation
+
+```bash
+# Install dependencies
+cd sapiense-ai-app
+npm install
+
+# Start the development server
+npm start
+```
+
+### Development
+
+```bash
+# Start on iOS
+npm run ios
+
+# Start on Android
+npm run android
+
+# Start on Web
+npm run web
+```
+
+### Building for Production
+
+Follow Expo's build guidelines:
+- [iOS Build](https://docs.expo.dev/build/setup/)
+- [Android Build](https://docs.expo.dev/build/setup/)
+
+## Environment Variables
+
+Create a `.env` file in the `sapiense-ai-app` directory (not tracked in git):
+
+```env
+# Add your environment variables here
+API_BASE_URL=http://localhost:8050
+```
+
+## API Integration
+
+The app connects to the News API service for content delivery. Make sure the News API service is running and accessible.
+
+## Contributing
+
+1. Create a feature branch
+2. Make your changes
+3. Test on multiple platforms
+4. Submit a pull request
+
+## License
+
+Proprietary - All rights reserved