A music player that connects to your cloud/distributed storage.
Merge pull request #387 from toraritte/suggestions
README suggestions
authored by
Steven Vandevelde
and committed by
GitHub
9e284e7a
8095bc56
+8
-5
+8
-5
README.md
+8
-5
README.md
···
13
13
### Integrations
14
14
15
15
Music layer for music storage.
16
-
User layer for user-data storage.
16
+
User layer for user-data storage.
17
17
18
18
#### Music layer
19
19
···
41
41
42
42
### Hosting on your own server
43
43
44
-
Diffuse is a static web application, which means it's just HTML, CSS and Javascript. No REST API, database, or anything backend-related involved. The app uses a hash, aka. fragment, based routing system, so you don't need any special server rules for routing. You can download a pre-build web-only version of Diffuse on the [releases](https://github.com/icidasset/diffuse/releases) page. Diffuse uses service workers, so you may need HTTPS for it to work smoothly in certain browsers.
44
+
Diffuse is a static web application, which means it's just HTML, CSS, and Javascript. No REST API, database, or anything backend-related involved. The app uses a hash (aka. fragment-based) routing system, so you don't need any special server rules for routing. You can download a pre-build web-only version of Diffuse on the [releases](https://github.com/icidasset/diffuse/releases) page. Diffuse uses service workers, so you may need HTTPS for it to work smoothly in certain browsers.
45
45
46
-
I should also note that some source services use OAuth, so you'll need to use your own application credentials (eg. google drive client id + secret). That said, if you're working locally you can use `http://localhost:8000` or `http://127.0.0.1:44999` to use the default ones, that's what the old Electron app was using.
46
+
I should also note that some source services use OAuth, so you'll need to use your own application credentials (eg. Google Drive client ID + secret). That said, if you're working locally, you can use `http://localhost:8000` or `http://127.0.0.1:44999` to use the default ones, that's what the old Electron app was using.
47
47
48
48
In short:
49
-
- Diffuse is a static, serverless, web application
49
+
- Diffuse is a static, serverless web application
50
50
- Routing is done using hashes/fragments (eg. `diffuse.sh/#/sources`)
51
51
- Download a web build on the [releases](https://github.com/icidasset/diffuse/releases) page
52
52
- Uses service workers (use HTTPS if possible)
···
66
66
```shell
67
67
# 🍱
68
68
69
-
# 1. Setup Nix environment
69
+
# 0. Install the Nix package manager
70
70
# https://nixos.org/download.html
71
+
72
+
# 1. Setup environment
73
+
nix develop
71
74
72
75
# 2. Install js dependencies
73
76
just install-deps