wip
This commit is contained in:
64
QUICK_START.md
Normal file
64
QUICK_START.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# MyCrib KMM - Quick Start
|
||||
|
||||
## 🚀 Switch API Environment
|
||||
|
||||
**File:** `composeApp/src/commonMain/kotlin/com/mycrib/shared/network/ApiConfig.kt`
|
||||
|
||||
```kotlin
|
||||
object ApiConfig {
|
||||
val CURRENT_ENV = Environment.LOCAL // ⬅️ CHANGE THIS
|
||||
}
|
||||
```
|
||||
|
||||
### Options:
|
||||
- **`Environment.LOCAL`** → Your local API (localhost)
|
||||
- **`Environment.DEV`** → Dev server (https://mycrib.treytartt.com)
|
||||
|
||||
### After Changing:
|
||||
1. **Android**: Sync Gradle and run
|
||||
2. **iOS**: Clean Build Folder (⇧⌘K) and run
|
||||
|
||||
### Verify in Logs:
|
||||
```
|
||||
🌐 API Client initialized
|
||||
📍 Environment: Local (10.0.2.2:8000)
|
||||
🔗 Base URL: http://10.0.2.2:8000/api
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📱 Run the Apps
|
||||
|
||||
### Android
|
||||
```bash
|
||||
cd MyCribKMM
|
||||
./gradlew :composeApp:installDebug
|
||||
```
|
||||
|
||||
### iOS
|
||||
```bash
|
||||
cd MyCribKMM/iosApp
|
||||
open iosApp.xcodeproj
|
||||
# Run in Xcode
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Start Local API
|
||||
|
||||
```bash
|
||||
cd myCribAPI
|
||||
./dev.sh # Auto-reload on code changes
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 Full Guides
|
||||
|
||||
- **Environment Setup**: `ENVIRONMENT_SETUP.md`
|
||||
- **Workspace Overview**: `../WORKSPACE_OVERVIEW.md`
|
||||
- **API Deployment**: `../myCribAPI/DOKKU_SETUP_GUIDE.md`
|
||||
|
||||
---
|
||||
|
||||
**That's it!** Change one line to toggle between local and remote development. ✨
|
||||
Reference in New Issue
Block a user