docs updated & some windows related bug fix

This commit is contained in:
KRTirtho 2021-03-21 19:09:42 +06:00
parent 5d0007fdb1
commit 4aa80fbee5
8 changed files with 23 additions and 13 deletions

View File

@ -1,4 +1,4 @@
# Spotube <img src="./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 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) ![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 ## 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 - [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 - [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 **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** 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 Now, Install youtube-dl from
- official github repo: https://github.com/ytdl-org/youtube-dl#installation (recommended) - official github repo: https://github.com/ytdl-org/youtube-dl#installation (recommended)
**or**
- snap installation - snap installation
```bash ```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 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)😂😔 **I'll/try to upload the package binaries to linux debian/arch/ubuntu/snap/flatpack/redhat/chocolatey stores or software centers or repositories**
Linux: [.appimage]()
**I'll/try to upload the package binaries to linux debian/arch/ubuntu/snap/flatpack/redhat stores or software centers or repositories**
## Configuration ## Configuration
@ -87,14 +86,14 @@ You need a spotify account & a web app for
**Windows Specific:** **Windows Specific:**
- Visual Studio 2017 & up - Visual Studio 2019
**MacOS & Linux specific:** **MacOS & Linux specific:**
- Make - Make
**Ubuntu/Debian based linux specific:** **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 ```bash
$ sudo apt-get install pkg-config build-essential mesa-common-dev libglu1-mesa-dev $ 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: ## TODO:
- Compile, Debug & Build for **Windows & MacOS** - Compile, Debug & Build for **MacOS**
- Add seek Lyric for currently playing track - Add seek Lyric for currently playing track
- Support for playing/streaming podcasts/shows - Support for playing/streaming podcasts/shows
- Easy installation procedure/mechanism for simplicity
#### Social handlers #### Social handlers

Binary file not shown.

Before

Width:  |  Height:  |  Size: 163 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 736 KiB

View File

@ -7,7 +7,7 @@
"private": true, "private": true,
"scripts": { "scripts": {
"build": "webpack --mode=production", "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": "qode ./dist/index.js",
"start:trace": "qode ./dist/index.js --trace", "start:trace": "qode ./dist/index.js --trace",
"debug": "qode --inspect ./dist/index.js", "debug": "qode --inspect ./dist/index.js",
@ -56,6 +56,7 @@
"@types/webpack-env": "^1.15.3", "@types/webpack-env": "^1.15.3",
"babel-loader": "^8.1.0", "babel-loader": "^8.1.0",
"clean-webpack-plugin": "^3.0.0", "clean-webpack-plugin": "^3.0.0",
"cross-env": "^7.0.3",
"file-loader": "^6.2.0", "file-loader": "^6.2.0",
"fork-ts-checker-webpack-plugin": "^6.1.0", "fork-ts-checker-webpack-plugin": "^6.1.0",
"native-addon-loader": "^2.0.1", "native-addon-loader": "^2.0.1",

View File

@ -2,7 +2,7 @@ import { QIcon, QMouseEvent } from "@nodegui/nodegui";
import { Text, View } from "@nodegui/react-nodegui"; import { Text, View } from "@nodegui/react-nodegui";
import React, { FC, useContext, useMemo } from "react"; import React, { FC, useContext, useMemo } from "react";
import playerContext from "../../context/playerContext"; import playerContext from "../../context/playerContext";
import { msToMinAndSec } from "../../helpers/msToMin:sec"; import { msToMinAndSec } from "../../helpers/msToMin_sec";
import useTrackReaction from "../../hooks/useTrackReaction"; import useTrackReaction from "../../hooks/useTrackReaction";
import { heart, heartRegular, pause, play } from "../../icons"; import { heart, heartRegular, pause, play } from "../../icons";
import IconButton from "./IconButton"; import IconButton from "./IconButton";