From 60ea638027f7973a444b859a082ae29aba03c64d Mon Sep 17 00:00:00 2001 From: julien9969 Date: Sun, 4 May 2025 01:06:39 -0400 Subject: [PATCH] chore: Added Development.md --- DEVELOPEMENT.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 DEVELOPEMENT.md diff --git a/DEVELOPEMENT.md b/DEVELOPEMENT.md new file mode 100644 index 0000000..242e8ee --- /dev/null +++ b/DEVELOPEMENT.md @@ -0,0 +1,61 @@ +# 🚀 Fladder Dev Setup + +## 🔧 Requirements + +Ensure the following tools are installed: + +- [Flutter SDK](https://flutter.dev/docs/get-started/install) (latest stable) +- [Android Studio](https://developer.android.com/studio) (for Android development and emulators) +- [VS Code](https://code.visualstudio.com/) with: + - Flutter extension + - Dart extension + +Verify your Flutter setup with: + +```bash +flutter doctor +``` + +## 🚀 Quick Start + +```bash +# Clone the repository +git clone https://github.com/DonutWare/Fladder.git +cd Fladder + +# Install dependencies +flutter pub get +``` + +## 🐧 Linux Dependencies + +If you're on **Linux**, install the `mpv` dependency: + +```bash +sudo apt install libmpv-dev +``` + +## 🛠️ Running the App + +1. **Connect a device** or launch an emulator. +2. In VS Code: + - Select the target device (bottom right corner). + - Press `F5` or go to **Run > Start Debugging**. + - If prompted, select **"Run Anyway"**. + +## ⚙️ Code Generation + +Generate build files (e.g., for `json_serializable`, `freezed`, etc.): + +```bash +flutter pub run build_runner build +``` + +> Tip: Use `watch` for continuous builds during development: +```bash +flutter pub run build_runner watch +``` + +## 🌐 Using a demo Server +You can use a fake server from jellyfin +https://demo.jellyfin.org/stable/web/ \ No newline at end of file