docs(readme): remove docs, netlify and docsify, keep only readme docs for now
This commit is contained in:
raiper34
@@ -1,9 +0,0 @@
|
||||
|
||||
|
||||
# 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)
|
||||
@@ -1 +0,0 @@
|
||||
Content
|
||||
@@ -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)
|
||||
@@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -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).
|
||||
@@ -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>
|
||||
@@ -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`
|
||||
@@ -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) |
|
||||
Reference in New Issue
Block a user