Flutter App
This commit is contained in:
49
README.md
49
README.md
@@ -16,14 +16,14 @@ Developed by Lambda Banking Conglomerate - A Star Citizen Organization
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Using Docker Compose (Recommended)
|
||||
### 1. Start Backend (Using Docker Compose - Recommended)
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone <repository-url>
|
||||
cd rmtPocketWatcher
|
||||
|
||||
# Start everything
|
||||
# Start backend and database
|
||||
docker-compose up -d
|
||||
|
||||
# View logs
|
||||
@@ -35,7 +35,29 @@ curl http://localhost:3000/health
|
||||
|
||||
The backend will be available at `http://localhost:3000`
|
||||
|
||||
### Local Development
|
||||
### 2. Run Flutter App
|
||||
|
||||
```bash
|
||||
cd flutter_app
|
||||
|
||||
# Install dependencies
|
||||
flutter pub get
|
||||
|
||||
# Configure environment
|
||||
cp .env.example .env
|
||||
# Edit .env if needed (default connects to localhost:3000)
|
||||
|
||||
# Run on Windows
|
||||
flutter run -d windows
|
||||
|
||||
# Run on Android
|
||||
flutter run -d android
|
||||
|
||||
# Run on iOS
|
||||
flutter run -d ios
|
||||
```
|
||||
|
||||
### Local Backend Development
|
||||
|
||||
```bash
|
||||
# Start database only
|
||||
@@ -67,7 +89,15 @@ rmtPocketWatcher/
|
||||
│ │ └── index.ts # Main server entry point
|
||||
│ ├── prisma/ # Database schema and migrations
|
||||
│ └── Dockerfile
|
||||
├── electron-app/ # Electron desktop app (coming soon)
|
||||
├── flutter_app/ # Flutter cross-platform app
|
||||
│ ├── lib/
|
||||
│ │ ├── models/ # Data models
|
||||
│ │ ├── providers/ # State management
|
||||
│ │ ├── services/ # API, WebSocket, Storage
|
||||
│ │ ├── screens/ # UI screens
|
||||
│ │ └── widgets/ # Reusable components
|
||||
│ └── pubspec.yaml
|
||||
├── electron-app/ # Legacy Electron app (deprecated)
|
||||
├── docker-compose.yml # Docker orchestration
|
||||
└── README.md
|
||||
```
|
||||
@@ -109,11 +139,12 @@ NODE_ENV=production
|
||||
- PostgreSQL + Prisma ORM
|
||||
- Node Scheduler (cron jobs)
|
||||
|
||||
**Frontend (Coming Soon):**
|
||||
- Electron 30+
|
||||
- React + TypeScript
|
||||
- TailwindCSS
|
||||
- Recharts/ECharts
|
||||
**Frontend:**
|
||||
- Flutter 3.38+ (cross-platform: Windows, macOS, Linux, Android, iOS)
|
||||
- Dart 3.10+
|
||||
- Provider (state management)
|
||||
- fl_chart (charting)
|
||||
- Material Design 3
|
||||
|
||||
## Development
|
||||
|
||||
|
||||
Reference in New Issue
Block a user