Skip to content

Getting Started

This guide will help you set up the Nice TV project locally for development.

Prerequisites

  • Flutter SDK ^3.13.0-282.1.beta — install via flutter.dev
  • Dart SDK (bundled with Flutter)
  • Android Studio or VS Code with Flutter/Dart plugins
  • Android SDK (for Android builds)
  • Git

Clone the Repository

git clone https://github.com/<your-org>/nice-tw-tv.git
cd nice-tw-tv

Environment Setup

  1. Copy the example environment file:
cp .env.example .env
  1. Edit .env with your Twitch credentials:
CLIENT_ID=your_twitch_client_id
TOKEN_PROXY_URL=https://nice-tv-token-proxy.involvex.workers.dev

For local-only debug without the proxy, you may set SECRET instead of TOKEN_PROXY_URL.

  1. In the Twitch Developer Console, set OAuth Redirect URL to:
https://twitch.tv/login

Install Dependencies

flutter pub get

Run the App

flutter run

To run on a specific device:

flutter devices
flutter run -d <device_id>

Hot Reload

While the app is running:

  • Press r in the terminal for hot reload
  • Press R for hot restart

Verify Setup

Run the verification checklist:

dart format .
flutter analyze
flutter test

Next Steps