Dymas/jarri-spooty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs(readme): remove docs, netlify and docsify, keep only readme docs for now

Browse Source
This commit is contained in:
raiper34
2025-04-05 21:51:53 +02:00
parent 48959ced4d
commit bc9482c6cb
14 changed files with 76 additions and 1404 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.release-it.json
+1 -1
View File
@@ -27,6 +27,6 @@
"hooks": {
"before:init": ["npm run clean"],
"after:bump": ["npm run changelog", "npm run build"],
"after:release": ["npm run deploy:docs"]
"after:release": []
}
}
README.md
+71 -14
View File
@@ -1,32 +1,89 @@
[![npm version](https://img.shields.io/docker/pulls/raiper34/spooty)](https://hub.docker.com/repository/docker/raiper34/spooty/general)
[![npm version](https://img.shields.io/docker/image-size/raiper34/spooty)](https://hub.docker.com/repository/docker/raiper34/spooty/general)
[![npm version](https://img.shields.io/docker/stars/raiper34/spooty)](https://hub.docker.com/repository/docker/raiper34/spooty/general)
[![docs](https://badgen.net/badge/docs/online/orange)](https://spooty.netlify.app)
[![npm version](https://img.shields.io/docker/pulls/raiper34/spooty)](https://hub.docker.com/r/raiper34/spooty)
[![npm version](https://img.shields.io/docker/image-size/raiper34/spooty)](https://hub.docker.com/r/raiper34/spooty)
[![npm version](https://img.shields.io/docker/stars/raiper34/spooty)](https://hub.docker.com/r/raiper34/spooty)
[![GitHub License](https://img.shields.io/github/license/raiper34/spooty)](https://github.com/Raiper34/spooty)
[![GitHub Repo stars](https://img.shields.io/github/stars/raiper34/spooty)](https://github.com/Raiper34/spooty)
![spooty logo](assets/logo.svg)
# Spooty - selfhosted Spotify downloader
Spooty is a self-hosted Spotify downloader.
It allows download track/playlist/album from the spotify url.
It allows download track/playlist/album from the Spotify url.
It can also subscribe to a playlist or author page and download new songs upon release.
The project is based on NestJS and Angular.
Spooty basically downloads nothing from Spotify, it only gets information from spotify and then finds relevant and downloadeds music on Youtube.
The project is based on NestJS and Angular.
> [!IMPORTANT]
> Please do not use this tool for piracy! Download only music you own rights! Use this tool only on your responsibility.
![demo](assets/demo.gif)
### Content
- [🚀 Instalation](#-instalation)
- [📚 Documentation](#-documentation)
- [📖 License](#-license)
- [🚀 Installation](#-installation)
- [Docker](#docker)
- [Docker command](#docker-command)
- [Docker compose](#docker-compose)
- [Build from source](#build-from-source)
- [Process](#requirements)
- [Requirements](#process)
- [Environment variables](#environment-variables)
- [⚖️ License](#-license)
# 🚀 Instalation
## 🚀 Installation
Recommended and the easiest way how to start to use of Spooty is using docker.
### Docker
Just run docker command or use docker compose configuration.
For detailed configuration, see available [environment variables](#environment-variables).
#### Docker command
```shell
docker run -d -p 3000:3000 -v /path/to/downloads:/spooty/backend/downloads raiper34/spooty:latest
```
# 📚 Documentation
For more details and complete documentation check: https://spooty.netlify.app/
#### Docker compose
```yaml
services:
spooty:
image: raiper34/spooty:latest
container_name: spooty
restart: unless-stopped
ports:
- "3000:3000"
volumes:
- /path/to/downloads:/spooty/backend/downloads
```
# 📖 License
MIT
### Build from source
Spooty can be also build from source files on your own.
#### Requirements
- Node v18.19.1 (it is recommended to use `nvm` node version manager to install proper version of node)
- Redis in memory cache
#### Process
- install Node v18.19.1 using `nvm install` and use that node version `nvm use`
- from project root install all dependencies using `npm install`
- copy `.env.default` as `.env` in `src/backend` folder and modify desired environment properties (see [environment variables](#environment-variables))
- build source files `npm run build`
- built project will be stored in `dist` folder
- start server `npm run start`
### Environment variables
Some behaviour and settings of Spooty can be configured using environment variables and `.env` file.
Name | Default | Description |
----------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
DB_PATH | `./config/db.sqlite` (relative to backend) | Path where Spooty database will be stored |
FE_PATH | `../frontend/browser` (relative to backend) | Path to frontend part of application |
DOWNLOADS_PATH | `./downloads` (relative to backend) | Path where downaloded files will be stored |
FORMAT | `mp3` | Format of downloaded files (currently fully supported only `mp3` but you can try whatever you want from [ffmpeg](https://ffmpeg.org/ffmpeg-formats.html#Muxers)) |
PORT | 3000 | Port of Spooty server |
REDIS_PORT | 6379 | Port of Redis server |
REDIS_HOST | localhost | Host of Redis server |
RUN_REDIS | false | Whenever Redis server should be started from backend (recommended for Docker environment) |
# ⚖️ License
[MIT](https://choosealicense.com/licenses/mit/)
docs/.nojekyll
View File
docs/_coverpage.md
-9
View File
@@ -1,9 +0,0 @@
![logo](assets/logo.svg)
# Spooty
> A self-hosted Spotify downloader
[GitHub](https://github.com/Raiper34/spooty)
[DockerHub](https://hub.docker.com/repository/docker/raiper34/spooty/general)
[Get Started](docker.md)
docs/_navbar.md
-1
View File
@@ -1 +0,0 @@
Content
docs/_sidebar.md
-6
View File
@@ -1,6 +0,0 @@
- Getting started
- [Using Docker](docker.md)
- [Build from source](source.md)
- [Environment variables](variables.md)
- [Changelog](CHANGELOG.md)
- [License](LICENSE.md)
docs/copy-files-from-to.json
-27
View File
@@ -1,27 +0,0 @@
{
"copyFilesSettings": {
"whenFileExists": "overwrite"
},
"copyFiles": [
{
"from": "*",
"to": "../dist/docs"
},
{
"from": "../assets",
"to": "../dist/docs"
},
{
"from": "../README.md",
"to": "../dist/docs/README.md"
},
{
"from": "../LICENSE.md",
"to": "../dist/docs/LICENSE.md"
},
{
"from": "../CHANGELOG.md",
"to": "../dist/docs/CHANGELOG.md"
}
]
}
docs/docker.md
-26
View File
@@ -1,26 +0,0 @@
# Docker
Recommended and the easiest way how to start to use of Spooty is using docker.
Just run docker command or use docker compose configuration.
### Docker command
```shell
docker run -d -p 3000:3000 -v /path/to/downloads:/spooty/backend/downloads raiper34/spooty:latest
```
### Docker compose
```yaml
services:
spooty:
image: raiper34/spooty:latest
container_name: spooty
restart: unless-stopped
ports:
- "3000:3000"
volumes:
- /path/to/downloads:/spooty/backend/downloads
```
### Environment variables
For detailed configuration, see available [Environment variables](variables.md).
docs/index.html
-31
View File
@@ -1,31 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
name: 'Spooty',
repo: 'https://github.com/Raiper34/spooty',
coverpage: true,
loadSidebar: true,
loadNavbar: false,
search: 'auto',
}
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-json.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-yaml.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
</body>
</html>
docs/source.md
-15
View File
@@ -1,15 +0,0 @@
# Build from source
Spooty can be also build from source files on your own.
### Requirements
- Node v18.19.1 (it is recommended to use `nvm` node version manager to install proper version of node)
- Redis in memory cache
### Process
- install Node v18.19.1 using `nvm install` and use that node version `nvm use`
- from project root install all dependencies using `npm install`
- copy `.env.default` as `.env` in `src/backend` folder and modify desired environment properties (see [Environment variables](variables.md))
- build source files `npm run build`
- built project will be stored in `dist` folder
- start server `npm run start`
docs/variables.md
-14
View File
@@ -1,14 +0,0 @@
# Environment variables
some behaviour and settings of Spooty can be configured using environment variables and `.env` file.
Name | Default | Description |
----------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
DB_PATH | `./config/db.sqlite` (relative to backend) | Path where Spooty database will be stored |
FE_PATH | `../frontend/browser` (relative to backend) | Path to frontend part of application |
DOWNLOADS_PATH | `./downloads` (relative to backend) | Path where downaloded files will be stored |
FORMAT | `mp3` | Format of downloaded files (currently fully supported only `mp3` but you can try whatever you want from [ffmpeg](https://ffmpeg.org/ffmpeg-formats.html#Muxers)) |
PORT | 3000 | Port of Spooty server |
REDIS_PORT | 6379 | Port of Redis server |
REDIS_HOST | localhost | Host of Redis server |
RUN_REDIS | false | Whenever Redis server should be started from backend (recommended for Docker environment) |
netlify.toml
-4
View File
@@ -1,4 +0,0 @@
[[redirects]]
from = "/*"
to = "/index.html"
status = 200
package-lock.json
Generated
+4 -1247
View File
File diff suppressed because it is too large Load Diff
package.json
-9
View File
@@ -10,13 +10,10 @@
"start:fe": "npm run start -w frontend",
"build:be": "npm run build -w backend",
"build:fe": "npm run build -w frontend",
"build:docs": "copy-files-from-to --config docs/copy-files-from-to.json",
"build": "npm run build:be && npm run build:fe",
"gen:fe": "npm run gen -w frontend",
"gen:be": "npm run gen -w backend",
"start": "npm run start:prod -w backend",
"docs": "docsify serve ./docs",
"deploy:docs": "npm run build:docs && netlify deploy --dir=dist/docs --prod",
"clean": "rimraf dist",
"changelog": "auto-changelog -p",
"release": "release-it",
@@ -29,15 +26,9 @@
"commitizen": "^4.3.1",
"copy-files-from-to": "^3.2.2",
"cz-conventional-changelog": "^3.3.0",
"docsify-cli": "^4.4.4",
"npm-check-updates": "^17.1.15",
"release-it": "^18.1.2",
"release-it-docker-plugin": "^2.0.0",
"rimraf": "^6.0.1"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
}
}