Flutter app added

Author: KRTirtho

.gitignore

@@ -1,22 +1,46 @@
-node_modules
-dist/
+# Miscellaneous
+*.class
 *.log
-# user specific
-cache/
-local/
-# debian build specific
-deb-struct/usr/lib/
-deb-struct/usr/bin/
-deb-struct/usr/share/applications
-# deply build binaries
-deploy/linux/build
-deploy/win32/build
-deploy/darwin/build
-# aur build specific
-aur-struct/src
-aur-struct/pkg
-aur-struct/*.zip*
-aur-struct/*.zst
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
 
-*.tsbuildinfo
-tsconfig.tsbuildinfo
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release

.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: 77d935af4db863f6abd0b9c31c7e6df2a13de57b
+  channel: stable
+
+project_type: app

README.md

@@ -0,0 +1,182 @@
+![Spotube](assets/spotube_banner.svg)
+
+Spotube is a [qt](https://qt.io) based lightweight spotify client which uses [nodegui/react-nodegui](https://github.com/nodegui/react-nodegui) as frontend & nodejs as backend. It utilizes the power of Spotify & Youtube's public API & creates a hazardless, performant & resource friendly User Experience
+![Application Screenshot](assets/spotube-screenshot.png)
+
+## Features
+
+Following are the features that currently spotube offers:
+
+- Open Source
+- No telementry, diagnostics or user data collection
+- Lightweight & resource friendly
+- Near native performance & seemless with default desktop themes (Win10, Win7, OSX, QT-default)
+- Playback control is on user's machine instead of server based
+- Small size & less data hungry
+- No spotify or youtube ads since it uses all public & free APIs (But it's recommended to support the creators by watching/liking/subscribing to the artists youtube channel or add as favourite track in spotify. Mostly buying spotify premium is the best way to support their valuable creations)
+- Lyrics
+- Downloadable track
+
+## Requirements (Linux🐧 only)
+
+Don't worry **spotify premium isn't required**😱. But some extra packages are required.
+
+- [MPV](https://mpv.io/installation/) player for playing the actual audio
+- [youtube-dl](https://github.com/ytdl-org/youtube-dl) for streaming the audio from youtube. It already comes pre bundled with mpv
+
+> **Important for [Ubuntu/Debian]():** If you're using any **ubuntu/debian** based linux distro then **youtube-dl** installed from the typical **apt-get** repositories will most likely not work as that version is older than current release. So remove it & install from the repository manually
+
+Remove the **youtube-dl** installed with **mpv** player or from **apt package manger**
+
+```bash
+$ sudo apt-get remove youtube-dl
+```
+
+Now, Install youtube-dl from
+
+- official github repo: https://github.com/ytdl-org/youtube-dl#installation (recommended)
+  **or**
+- snap installation
+  ```bash
+  $ snap install youtube-dl
+  ```
+
+## Installation
+
+I'm always releasing newer versions of binary of the software each 2-3 month with minor changes & each 6-8 month with major changes. Grab the binaries
+
+All the binaries are located in the [releases](https://github.com/krtirtho/spotube/releases), just download
+
+### Windows
+
+Extract the **`Spotube-winx64-v<version>.zip`** & double click on **`install.bat`** & follow along the installer
+
+### Linux
+
+- **Ubuntu/Debian**
+  Make sure you've fulfilled all the requirements
+  ```bash
+  sudo apt install spotube_linux-x86_64-v<version>.deb
+  or
+  sudo dpkg -i spotube_linux-x86_64-v<version>.deb
+  ```
+- **Others**: Navigate to the downloaded **`Spotube_linux-x86_64-v<version>.AppImage`**
+  file & double click to run it
+
+**I'll/try to upload the package binaries to linux debian/arch/ubuntu/snap/flatpack/redhat/chocolatey stores or software centers or repositories**
+
+## Configuration
+
+There are some configurations that needs to be done to start using this software
+
+You need a spotify account & a web app for
+
+- clientId
+- clientSecret
+
+**Grab credentials:**
+
+- Go to https://developer.spotify.com/dashboard/login & login with your spotify account (Skip if you're logged in)
+  ![Step 1](https://user-images.githubusercontent.com/61944859/111762106-d1d37680-88ca-11eb-9884-ec7a40c0dd27.png)
+
+- Create an web app for Spotify Public API
+  ![step 2](https://user-images.githubusercontent.com/61944859/111762507-473f4700-88cb-11eb-91f3-d480e9584883.png)
+
+- Give the app a name & description. Then Edit settings & add **http://localhost:4304/auth/spotify/callback** as **Redirect URI** for the app. Its important for authenticating
+  ![setp-3](https://user-images.githubusercontent.com/61944859/111768971-d308a180-88d2-11eb-9108-3e7444cef049.png)
+
+- Click on **SHOW CLIENT SECRET** to reveal the **clientSecret**. Then copy the **clientID**, **clientSecret** & paste in the **Spotube's** respective fields
+  ![step-4](https://user-images.githubusercontent.com/61944859/111769501-7fe31e80-88d3-11eb-8fc1-f3655dbd4711.png)
+
+> **Note!**: No personal data or any kind of sensitive information won't be collected from spotify. Don't believe? See the code for yourself
+
+### Building from source
+
+**nodegui/react-nodegui** requires following packages to run
+
+- [CMake](https://cmake.org/install/) 3.1 & up
+- GCC v7
+- Nodejs 12.x & up
+
+**Windows Specific:**
+
+- Visual Studio 2019
+
+**MacOS & Linux specific:**
+
+- Make
+
+**Ubuntu/Debian based linux specific:**
+Having `pkg-config build-essential mesa-common-dev libglu1-mesa-dev` is important
+
+```bash
+$ sudo apt-get install pkg-config build-essential mesa-common-dev libglu1-mesa-dev
+```
+
+After having this dependencies set up run following commands:
+
+```bash
+$ git clone https://github.com/KRTirtho/spotube.git
+$ cd spotube
+$ npm install
+```
+
+Now start building:
+
+```bash
+$ npm run build
+$ npm run pack
+```
+
+Go to built package directory replace `os-name` with `linux`|`win32`|`darwin`:
+
+```bash
+$ cd deploy/<os-name>/build/spotube
+```
+
+If everything went smoothly then double clicking on the
+
+- `AppRun` or Spotube-x86_64.AppImage for **linux**
+- qode.exe for **Windows**
+- Spotube-x86_64.dmg for **MacOS**
+
+should work just fine without any problem
+
+### Development
+
+Follow the **Build from Source** guideline till `npm install`
+Now, to start the dev server run the command in one terminal:
+
+```bash
+$ npm run dev
+```
+
+To start the application in development environment run following command in another terminal keeping the dev server running:
+
+```bash
+$ npm start
+```
+
+## Known Issues
+
+There will be some glitches, lags & stuck motions because of the library Spotube is currently using under the hood. It has some issues with layouts thus sometimes some contents aren't shown or overflows out of the window. But resizing the window would fix this issue. Soon there will be some updates fixing this sort of layout related problems
+
+## TODO:
+
+- [ ] Compile, Debug & Build for **MacOS**
+- [x] Add support for show Lyric of currently playing track
+- [x] Track download
+- [x] Cached playback
+- [ ] Support for playing/streaming podcasts/shows
+- [x] Easy installation procedure/mechanism for simplicity in Windows
+- [ ] Artist, User & Album pages
+
+## Things that don't work
+
+- Shows & Podcasts aren't supported as it'd require premium anyway
+- Beautiful UI (you missed it, see the title😂👆)
+- OS Media Controls
+
+#### Social handlers
+
+Follow me on [Twitter](https://twitter.com/@krtirtho) for newer updates about this application

analysis_options.yaml

@@ -0,0 +1,29 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at
+  # https://dart-lang.github.io/linter/lints/index.html.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

android/.gitignore

@@ -0,0 +1,13 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties
+**/*.keystore
+**/*.jks

android/app/build.gradle

@@ -0,0 +1,68 @@
+def localProperties = new Properties()
+def localPropertiesFile = rootProject.file('local.properties')
+if (localPropertiesFile.exists()) {
+    localPropertiesFile.withReader('UTF-8') { reader ->
+        localProperties.load(reader)
+    }
+}
+
+def flutterRoot = localProperties.getProperty('flutter.sdk')
+if (flutterRoot == null) {
+    throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
+}
+
+def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
+if (flutterVersionCode == null) {
+    flutterVersionCode = '1'
+}
+
+def flutterVersionName = localProperties.getProperty('flutter.versionName')
+if (flutterVersionName == null) {
+    flutterVersionName = '1.0'
+}
+
+apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
+apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
+
+android {
+    compileSdkVersion flutter.compileSdkVersion
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
+    }
+
+    defaultConfig {
+        // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
+        applicationId "com.example.spotube"
+        minSdkVersion flutter.minSdkVersion
+        targetSdkVersion flutter.targetSdkVersion
+        versionCode flutterVersionCode.toInteger()
+        versionName flutterVersionName
+    }
+
+    buildTypes {
+        release {
+            // TODO: Add your own signing config for the release build.
+            // Signing with the debug keys for now, so `flutter run --release` works.
+            signingConfig signingConfigs.debug
+        }
+    }
+}
+
+flutter {
+    source '../..'
+}
+
+dependencies {
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+}

android/app/src/debug/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.example.spotube">
+    <!-- Flutter needs it to communicate with the running application
+         to allow setting breakpoints, to provide hot reload, etc.
+    -->
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>