tcsenpai/swingmusic
1
0
Fork 0
mirror of https://github.com/tcsenpai/swingmusic.git synced 2025-06-06 03:05:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme and changelog file

Browse Source
This commit is contained in:
mungai-njoroge 2023-10-14 20:28:01 +03:00
parent 11b12efa39
commit c5f42360f7
3 changed files with 67 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
.github/changelog.md vendored
View File

@ -1,6 +1,8 @@
![Image showing Post Malone](https://github.com/swing-opensource/swingmusic/assets/48554537/7ddcf688-7b49-4f8f-8a78-20685fb14f2f)
Swing Music v1.3.0 is **FINALLY** here!
## Summary
## Release Summary
This release is ... _Bigger, Better, Faster, More!_
@ -10,25 +12,30 @@ This release is ... _Bigger, Better, Faster, More!_
4. Saving things as playlists
5. Adding things to playlists
6. Major UI redesign
7. Many bug fixes!
7. Drop Ubuntu 18 support
8. Proper Docker support
9. Many bug fixes!
## Full Changelog
### What's New?
- Related artists - You can now explore related artists in the artist page
- Related albums - Explore albums similar to the current one, in the album page.
- Mobile port for the client - You can now use the web client in a mobile browser. For best experience, install it as a PWA on chromium browsers. If you’re not prompted to `Add Swing Music to Home screen` after ~30s on the app, click the 3 dots on the top right corner and select `Add to Home screen`.
- You can also also install the client as a standalone app on desktop. Click the install button on the URL to install.
- You can also also install the client as a standalone app on desktop. Click the install button on the URL bar to install.
- Album versions - Explore other versions of an album at the bottom of the album tracklist.
- Recently added in favorites page
- Recently added albums and artists in favorites page
- You can now use square images in playlist page. Open the update playlist dialog to toggle the feature per playlist.
- Save folder as playlist.
- Save album as playlist. Use album thumbnail as playlist image.
- Save artists as playlist. Use artist image as playlist image.
- Add folder/album/artist to playlist or queue
- Top results section in sidebar search and search page.
- Playlist page redesign to introduce header.
- Playlist page redesign to introduce large text.
- Join EP & Singles in artist page
- Make artist page with many albums faster
- TTY progress bars look a tiny bit consistent
- Make artist page faster (removed 100+ lines of 💩 code)
- Pinned playlists! You can now pin a playlist for quick access.
- New opt-in simple artist page header. Enable in settings.
- 8 new settings added to the settings page
@ -38,26 +45,30 @@ This release is ... _Bigger, Better, Faster, More!_
4. Clean album titles
5. Merge album versions
6. Hide prod.
7. Hide remaster info
8. Extract featured artists
7. Hide remaster info from tracks and albums
10. Extract featured artists from metadata
### Enhancements
- Remove previous shuffle behavior shuffling the queue only shuffled following tracks and moves the current one to the top of the queue.
- Remove previous shuffle behavior (shuffling the queue only shuffled following tracks and moves the current one to the top of the queue)
- Better colors in page headers
- Run the populate function on boot, even with the `-nps` (no periodic scans) flag.
- Redesign queue page
- Always scan files on boot, even with the `-nps` (no periodic scans) flag.
- Redesign queue page to feature a large track thumbnail
- Show artist decade & genres in artist page
- Better command line help text
- Code enhancements
- Swing Music process naming
- Enhanced command line help text
- Swing Music process name now shows host and port
- Various UI redesigns and UX improvements.
- Less pink, more white.
- Move to monochrome logos and color schemes
- Search tab buttons and left sidebar items redesign
- Better color schemes in album header and playlist page
### Bug Fixes
- Blank page on the browser on Windows caused by missing mime types.
- Ed Sheeran tracks being in a single album (due to their album names being only one non-alphanumeric character ... f**k Ed) you might lose some favorites though.
- Artist and album cards being cropped
- A lot more actually! I lost track of most of them.
##
Album of the Release • AUSTIN • [Listen on Spotify](https://open.spotify.com/album/6r1lh7fHMB499vGKtIyJLy)

54
README.md
View File

@ -1,19 +1,21 @@
# Swing music (v1.3.0 releasing soon!)
<div style="display: flex; justify-content: center; align-items: center;">
<img class="lo" src='./screenshots/logo-fill.light.svg' style="height: 5rem">
</div>
<div style="text-align: center; font-size: 2rem"><b>Swing Music</b></div>
<div style="text-align: center"><b><code>v1.3.0</code></b></div>
##
**<div style="text-align: center; padding-top: 1.25rem">[`Download`](https://swingmusic.vercel.app/downloads) • <a href="https://swingmusic.vercel.app/support-us.html" target="_blank">`Support Development`</a> • [Browse Docs](https://swingmusic.vercel.app/guide/introduction.html) • [Screenshots](https://swingmusic.vercel.app)</div>**
##
Swing Music is a beautiful, self-hosted music player for your local audio files. Like a cooler Spotify ... but bring your own music. Just run the app and enjoy your music library in a web browser.
<a href="https://swingmusic.vercel.app/support-us.html" target="_blank"><img src="screenshots/supportus.png" alt="Buy Me A Coffee" style="height: 60px !important;width: auto !important;" ></a>
### Installation
| ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/artist.webp) | ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/album.webp) |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
| ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/artist2.webp) | ![SWING MUSIC PLAYER BANNER IMAGE](screenshots/album2.webp) |
Swing Music is available as pre-compiled binaries for Windows and Linux. Just download the latest release from the [downloads page](https://swingmusic.vercel.app/downloads) and launch it.
For full size screenshots, visit the [website](https://swingmusic.vercel.app).
### Setup
Swing Music is available as pre-compiled binaries for Windows and Linux. Just download the latest release from
the [release page](https://github.com/geoffrey45/swingmusic/releases) and launch it.
For Linux, you need to make the file executable first.
```bash
@ -22,42 +24,22 @@ chmod a+x ./swingmusic
./swingmusic
```
The app should start at <http://localhost:1970> by default. You can change the default port or host by using
the `--host` and `--port` flags.
The app should start at <http://localhost:1970> by default. Open it in your browser to use Swing Music. You can change the default port by using the `--port` flags.
```
Usage: swingmusic [options]
```sh
swingmusic --port 1980
```
### Options
| Option | Short | Description |
| -------------------- | ------ | ----------------------------------------------------------------------------- |
| `--help` | `-h` | Show help message |
| `--version` | `-v` | Show the app version |
| `--host` | | Set the host |
| `--port` | | Set the port |
| `--config` | | Set the config path |
| `--no-periodic-scan` | `-nps` | Disable periodic scan |
| `--scan-interval` | `-psi` | Set the periodic scan interval in seconds. Default is 300 seconds (5 minutes) |
| `--build` | | Build the application (in development) |
To stream your music across your local network, use the `--host` flag to run the app in all ports. Like this:
```sh
swingmusic --host 0.0.0.0
```
The link to access the app will be printed on your terminal. Open it in your browser to use Swing Music.
[Browse Docs](https://swingmusic.vercel.app)
Options are flags that can be passed when starting the app in the terminal to tweak runtime settings or perform tasks. Example: the `--port` flag. Read more about options in [the docs](https://swingmusic.vercel.app/guide/getting-started.html#options).
### Docker
Pull the latest Docker image and run it:
```sh
docker pull ghcr.io/swing-opensource/swingmusic:v1.3.0
docker pull ghcr.io/swing-opensource/swingmusic:latest
```
```sh

23
screenshots/logo-fill.light.svg Normal file
View File

@ -0,0 +1,23 @@
<svg width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg">
<g clip-path="url(#clip0_14_3)">
<path d="M14 27.6441C21.5354 27.6441 27.6441 21.5354 27.6441 14C27.6441 6.46458 21.5354 0.355927 14 0.355927C6.46461 0.355927 0.355957 6.46458 0.355957 14C0.355957 21.5354 6.46461 27.6441 14 27.6441Z" fill="white"/>
<g filter="url(#filter0_d_14_3)">
<path d="M14.1221 14.9372C15.6529 14.9372 17.1518 14.8463 18.3804 14.6644C19.3548 14.517 19.66 13.7979 19.329 12.7716L17.499 7.00511C17.1672 5.94913 16.3182 5.45764 15.1465 5.45764H13.0908C11.9191 5.45764 11.07 5.94913 10.7383 7.00511L8.90825 12.7716C8.57724 13.7979 8.88246 14.517 9.85688 14.6644C11.0855 14.8463 12.5856 14.9372 14.1221 14.9372ZM13.4838 14.451V22.1166H14.756V14.451H13.4838ZM10.9926 22.6014H17.2447C17.5434 22.6014 17.7469 22.3873 17.7469 22.0759C17.7469 21.4994 17.277 21.099 16.5694 21.099H11.6679C10.9603 21.099 10.4973 21.4994 10.4973 22.0759C10.4973 22.3873 10.6939 22.6014 10.9926 22.6014Z" fill="black"/>
</g>
</g>
<defs>
<filter id="filter0_d_14_3" x="4.77966" y="5.45764" width="18.678" height="25.1438" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
<feFlood flood-opacity="0" result="BackgroundImageFix"/>
<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/>
<feOffset dy="4"/>
<feGaussianBlur stdDeviation="2"/>
<feComposite in2="hardAlpha" operator="out"/>
<feColorMatrix type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0.25 0"/>
<feBlend mode="normal" in2="BackgroundImageFix" result="effect1_dropShadow_14_3"/>
<feBlend mode="normal" in="SourceGraphic" in2="effect1_dropShadow_14_3" result="shape"/>
</filter>
<clipPath id="clip0_14_3">
<rect width="28" height="28" fill="white"/>
</clipPath>
</defs>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.8 KiB