docs first attempt
This commit is contained in:
raiper34
@@ -2,3 +2,5 @@
|
|||||||
/dist
|
/dist
|
||||||
/.idea
|
/.idea
|
||||||
**/*.sqlite
|
**/*.sqlite
|
||||||
|
# Local Netlify folder
|
||||||
|
.netlify
|
||||||
|
|||||||
@@ -0,0 +1,3 @@
|
|||||||
|
### Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file. Dates are displayed in UTC.
|
||||||
+21
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2022 Filip Gulan
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -1,6 +1,24 @@
|
|||||||
# Spooty
|
# Spooty - selfhosted Spotify downloader
|
||||||
### Self-hosted spotify downloader
|
Spooty is a self-hosted Spotify downloader.
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Content
|
||||||
|
- [🚀 Instalation](#-instalation)
|
||||||
|
- [📚 Documentation](#-documentation)
|
||||||
|
- [📖 License](#-license)
|
||||||
|
|
||||||
|
# 🚀 Instalation
|
||||||
|
Recommended and the easiest way how to start to use of Spooty is using docker.
|
||||||
```shell
|
```shell
|
||||||
docker run --rm -p 3000:3000 -v /home/raiper34/Hudba:/usr/src/app/spooty-be/dist/downloads spooty-test-1
|
docker run -d -p 3000:3000 -v /path/to/downloads:/spooty/dist/backend/downloads spooty
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# 📚 Documentation
|
||||||
|
For more details and complete documentation check: https://spooty.netlify.app/
|
||||||
|
|
||||||
|
# 📖 License
|
||||||
|
MIT
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 152 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
@@ -0,0 +1,6 @@
|
|||||||
|
# Spooty
|
||||||
|
|
||||||
|
> A self-hosted Spotify downloader
|
||||||
|
|
||||||
|
[GitHub](https://github.com/Raiper34/spooty)
|
||||||
|
[Get Started](docker.md)
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
Content
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
- Getting started
|
||||||
|
- [Using Docker](docker.md)
|
||||||
|
- [Build from source](source.md)
|
||||||
|
- [Changelog](CHANGELOG.md)
|
||||||
|
- [License](LICENSE.md)
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"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"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Docker
|
||||||
|
|
||||||
|
TODO
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
<!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>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Build from source
|
||||||
|
|
||||||
|
TODO
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
[[redirects]]
|
||||||
|
from = "/*"
|
||||||
|
to = "/index.html"
|
||||||
|
status = 200
|
||||||
Generated
+25399
-8
File diff suppressed because it is too large
Load Diff
+13
-2
@@ -1,13 +1,24 @@
|
|||||||
{
|
{
|
||||||
"name": "spooty",
|
"name": "spooty",
|
||||||
"workspaces": ["src/backend", "src/frontend"],
|
"workspaces": [
|
||||||
|
"src/backend",
|
||||||
|
"src/frontend"
|
||||||
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start:be": "npm run start:dev -w backend",
|
"start:be": "npm run start:dev -w backend",
|
||||||
"start:fe": "npm run start -w frontend",
|
"start:fe": "npm run start -w frontend",
|
||||||
"build:be": "npm run build -w backend",
|
"build:be": "npm run build -w backend",
|
||||||
"build:fe": "npm run build -w frontend",
|
"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",
|
"build": "npm run build:be && npm run build:fe",
|
||||||
"gen:fe": "npm run gen -w frontend",
|
"gen:fe": "npm run gen -w frontend",
|
||||||
"start": "npm run start:prod -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"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"copy-files-from-to": "^3.2.2",
|
||||||
|
"docsify-cli": "^4.4.4",
|
||||||
|
"netlify-cli": "^10.5.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,7 +20,7 @@
|
|||||||
"test:e2e": "jest --config ./test/jest-e2e.json"
|
"test:e2e": "jest --config ./test/jest-e2e.json"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@distube/ytdl-core": "^4.13.5",
|
"@distube/ytdl-core": "^4.14.4",
|
||||||
"@nestjs/common": "^10.0.0",
|
"@nestjs/common": "^10.0.0",
|
||||||
"@nestjs/config": "^3.2.2",
|
"@nestjs/config": "^3.2.2",
|
||||||
"@nestjs/core": "^10.0.0",
|
"@nestjs/core": "^10.0.0",
|
||||||
|
|||||||
Reference in New Issue
Block a user