Mutiny Music Svelte

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Music Web Player, with howlerjs multiple code support (MP3, MPEG, OPUS, OGG, OGA, WAV, AAC, CAF, M4A, MP4, WEBA, WEBM, FLAC), compatible with API subsonic client.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites for development

This is an example of how to list things you need to use the software and how to install them.

• with pnpm (can use npm or yarn)

  pnpm install pnpm@latest -g
  

Installation for development

Local

1. Clone the repo

   git clone https://github.com/otakuryo/mutiny-music-svelte.git
   

2. Copy .env.example to .env
3. Install PNPM packages

   pnpm install
   

4. Configure package.json ports for dev (default 3000)
5. Run dev environment

   pnpm run dev
   

6. Open https://localhost:3000 (on macos use https://127.0.0.1:3000)

Docker

1. Clone the repo

   git clone https://github.com/otakuryo/mutiny-music-svelte.git
   

2. Run

   docker-compose up -d
   

3. Open https://localhost:3000 (on macos use https://127.0.0.1:3000)

(back to top)

For use with ssl

Can use SSL with docker, for this you need to create a folder called cert in the root of the project, and inside it place the files cert.pem and key.pem (or rename them in the docker-compose.yml file).

On macos can use mkcert for create self-signed certificates.

mkcert -install
cd cert
mkcert -key-file key.pem -cert-file cert.pem localhost

| More info https://stackoverflow.com/questions/73205096/run-sveltekit-dev-with-https

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Write and detail readme project
• Custom domain public
• Clear spanish comments
• Move SRC folder to LIB folder

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache License 2.0. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/otakuryo/mutiny-music-svelte

(back to top)

Acknowledgments

• Nothing

(back to top)