Muse

Just a simple, Electron-React app, to download audio from YouTube and play them.

Table of contents

• Technologies
• Features
• Installing
• Requirements
• Contributing
• Author
• License

Screenshots

🛠 Technologies

The following tools were used in this project construction:

• Koa
• Vite
• Rome
• Vitest
• Node.js
• React
• Tailwind
• Electron
• zustand
• TypeScript
• Ytdl Core
• React Icons
• Node TagLib Sharp
• Fluent FFmpeg

Features

• Copy an URL and see a message asking if you want to download an 'mp3' version of the media. 📫

• Share media with devices on the same WiFi network.

• Get the media's lyrics.

• App auto-updates when a new version is available.

🚀 Installing

To install and run Muse, follow these steps:

• Linux
  Download 'Muse-version.AppImage' from the releases page; Once downloaded, you need to make it an executable. On your terminal, run chmod a+x Muse-*.AppImage. Now you can run Muse: ./Muse-*.AppImage

Develop

To install and run Muse, follow these steps:

git clone https://github.com/Gabriel-Alves-Cunha/muse --depth 1

# Install dependencies
yarn

# Start app:
yarn dev

💻 Requirements

For development, before everything, verify that:

• You have the most recent (LTS) version of git, Node.JS and yarn

📫 Contributing

To contribute to Muse, follow these steps:

1. Fork this repo.
2. Create a branch: git checkout -b <my_branch_name>.
3. Make your alterations e confirm them: git commit -am '<commit_message>'
4. Send to the original branch: git push origin <my_branch_name>
5. Create a pull request.

As an alternative, consult the docs from GitHub on how to create a pull request.

Author

<img alt="Gabriel Alves Cunha Github's profile picture." src="https://github.com/Gabriel-Alves-Cunha.png" style="border-radius: 50%;" width="100px" />

_{Gabriel Alves Cunha}

Made with ❤️ by Gabriel Alves Cunha 👋🏽!

📝 License

This project is under the MIT license. See the LICENCE for more details.