diff --git a/README.md b/README.md index dd577fb0..fe85463e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Spotube + 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 ![spotube](https://user-images.githubusercontent.com/61944859/111771249-a7d38180-88d5-11eb-85f2-d9db57717694.png) @@ -18,11 +18,13 @@ Following are the features that currently spotube offers: ## Requirements -Don't worry **spotify premium isn't required**😱. But some extra packages required. +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 +**Tip!:** If you're using windows try installing **mpv & youtube-dl** player with **chocolatey package manager** as it'd make the installation a lot easier + **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** @@ -34,6 +36,7 @@ $ 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 @@ -44,13 +47,9 @@ $ snap install youtube-dl 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 -Windows: [.exe]() +All the binaries are located in the [releases](https://github.com/krtirtho/spotube/releases) -OSX: **I hate apple** (Just kidding, actually don't have a mac)😂😔 - -Linux: [.appimage]() - -**I'll/try to upload the package binaries to linux debian/arch/ubuntu/snap/flatpack/redhat stores or software centers or repositories** +**I'll/try to upload the package binaries to linux debian/arch/ubuntu/snap/flatpack/redhat/chocolatey stores or software centers or repositories** ## Configuration @@ -87,14 +86,14 @@ You need a spotify account & a web app for **Windows Specific:** -- Visual Studio 2017 & up +- Visual Studio 2019 **MacOS & Linux specific:** - Make **Ubuntu/Debian based linux specific:** -Having `pkg-config build-essential mesa-common-dev libglu1-mesa-dev` is advisable +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 @@ -150,9 +149,10 @@ There will be some glitches, lags & stuck motions because of the library Spotube ## TODO: -- Compile, Debug & Build for **Windows & MacOS** +- Compile, Debug & Build for **MacOS** - Add seek Lyric for currently playing track - Support for playing/streaming podcasts/shows +- Easy installation procedure/mechanism for simplicity #### Social handlers diff --git a/assets/demo.png b/assets/demo.png deleted file mode 100644 index b0f23773..00000000 Binary files a/assets/demo.png and /dev/null differ diff --git a/assets/nodegui.jpg b/assets/nodegui.jpg deleted file mode 100644 index 4b544b71..00000000 Binary files a/assets/nodegui.jpg and /dev/null differ diff --git a/assets/spotube_banner.svg b/assets/spotube_banner.svg new file mode 100644 index 00000000..76f4a7f8 --- /dev/null +++ b/assets/spotube_banner.svg @@ -0,0 +1,9 @@ + + +Spotube \ No newline at end of file diff --git a/deploy/linux/spotube/default.png b/deploy/linux/spotube/default.png deleted file mode 100644 index e69de29b..00000000 diff --git a/package.json b/package.json index 93ec81b8..233a5f82 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "private": true, "scripts": { "build": "webpack --mode=production", - "dev": "TSC_WATCHFILE=UseFsEvents webpack --mode=development", + "dev": "cross-env TSC_WATCHFILE=UseFsEvents webpack --mode=development", "start": "qode ./dist/index.js", "start:trace": "qode ./dist/index.js --trace", "debug": "qode --inspect ./dist/index.js", @@ -56,6 +56,7 @@ "@types/webpack-env": "^1.15.3", "babel-loader": "^8.1.0", "clean-webpack-plugin": "^3.0.0", + "cross-env": "^7.0.3", "file-loader": "^6.2.0", "fork-ts-checker-webpack-plugin": "^6.1.0", "native-addon-loader": "^2.0.1", diff --git a/src/components/shared/TrackButton.tsx b/src/components/shared/TrackButton.tsx index 3cacdb25..bed17669 100644 --- a/src/components/shared/TrackButton.tsx +++ b/src/components/shared/TrackButton.tsx @@ -2,7 +2,7 @@ import { QIcon, QMouseEvent } from "@nodegui/nodegui"; import { Text, View } from "@nodegui/react-nodegui"; import React, { FC, useContext, useMemo } from "react"; import playerContext from "../../context/playerContext"; -import { msToMinAndSec } from "../../helpers/msToMin:sec"; +import { msToMinAndSec } from "../../helpers/msToMin_sec"; import useTrackReaction from "../../hooks/useTrackReaction"; import { heart, heartRegular, pause, play } from "../../icons"; import IconButton from "./IconButton"; diff --git a/src/helpers/msToMin:sec.ts b/src/helpers/msToMin_sec.ts similarity index 100% rename from src/helpers/msToMin:sec.ts rename to src/helpers/msToMin_sec.ts