Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rosano/joybox
A pinboard for audiovisual media.
https://github.com/rosano/joybox
0data fission local-first offline-first remotestorage unhosted
Last synced: 16 days ago
JSON representation
A pinboard for audiovisual media.
- Host: GitHub
- URL: https://github.com/rosano/joybox
- Owner: rosano
- License: other
- Created: 2021-03-30T15:31:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-02T20:52:00.000Z (8 months ago)
- Last Synced: 2024-04-14T01:46:17.205Z (7 months ago)
- Topics: 0data, fission, local-first, offline-first, remotestorage, unhosted
- Language: JavaScript
- Homepage: https://joybox.rosano.ca
- Size: 295 KB
- Stars: 21
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Joybox](https://joybox.rosano.ca)
_A pinboard for audiovisual media_
Joybox makes it simple to play media from multiple platforms in the same place. Read the guide for more details.
## Architecture
The project follows a [Universal folder structure](https://rosano.hmm.garden/01f71kp52knc5nnv08qr9kzj3m) and is a large collection of mostly small modules or functions that are put together using [Svelte](https://svelte.dev) and [Rollup](https://rollupjs.org). With the exception of a few 'global' or 'magic' things such as the localization function `OLSKLocalized`, most resources used by a module should be in the same folder or referenced by path name.
Routing, rendering markdown content, and serving pages is done via a Node.js server (usually configured in the *controller.js* files).
## Development Setup
(For a deeper dive, watch [the tutorial](https://rosano.hmm.garden/01f62t5yseb053m024v1mczbzy)).
Install [Node.js and npm](https://nodejs.org/en/download/), then:
```
npm run setup
```
This should create an `.env` file if there is none. If you encounter errors referring to this file, you can find missing variables in `.env-sample`.
## Running
### Start the Rollup process to build and reload automatically
```
npm run watch
```
### Start the Node.js server to view in the browser
```
npm start
```
It should be accessible at http://localhost:3000.
## Testing
See [Testing logic and interfaces](https://rosano.hmm.garden/01f7v3hk3txz5d0v9ms467x8bz) for a tutorial.
### Run logic tests
```
npm test
```
### Run interface tests
```
npm test ui
```
To filter interface test paths by string:
```
npm test ui match=detail
```
To filter interface test paths by JavaScript regular expressions:
```
npm test ui match='/(vitrine|guide)/'
```
## ❤️
Help me keep creating projects that are public, accessible for free, and open-source.
## License
The code is released under a [Hippocratic License](https://firstdonoharm.dev), modified to exclude its use for surveillance capitalism and also to require large for-profit entities to purchase a paid license.
## Questions
Feel free to reach out on [Mastodon](https://rosano.ca/mastodon) or [Twitter](https://rosano.ca/twitter).