YesPlayMusic

If a pre-built binary is not available for your architecture, you can build your own using Node.js and Yarn.

1. Prerequisites: Install Node.js and Yarn (npm install -g yarn).
2. Clone: git clone --recursive https://github.com/qier222/YesPlayMusic.git
3. Setup:
   • yarn install
   • Copy .env.example to .env
4. Build Commands:

Output files will be located in the /dist_electron directory.

YesPlayMusic provides an Electron-based desktop client for macOS, Windows, and Linux. You can download pre-built installation packages from the Releases page or use package managers:

• macOS: Use Homebrew

  brew install --cask yesplaymusic

• Windows: Use Scoop

  scoop install extras/yesplaymusic

To develop or run the project locally, follow these steps:

1. Install Dependencies:

   yarn install

2. **Environment Setup**: 
 ```bash
 cp .env.example .env

3. Run Web Version:

   yarn serve

4. **Run Electron Version**: 
 ```bash
yarn electron:serve

5. Run Local API (Optional, defaults to port 3000):

   yarn netease_api:run

You can containerize YesPlayMusic using Docker or Docker Compose.

Build and Run with Docker:

docker build -t yesplaymusic .
docker run -d --name YesPlayMusic -p 80:80 yesplaymusic

Run with Docker Compose:

docker-compose up -d

After running, the application will be available at http://localhost.

1. Create a new Repl using the Bash template.
2. Run the installation script in the Replit shell:

   bash <(curl -s -L https://raw.githubusercontent.com/qier222/YesPlayMusic/main/install-replit.sh)

3. If the build fails due to Replit's memory limits (1GB/3GB), run the following manually:
 ```bash
 cd /home/runner/${REPL_SLUG}/music && yarn install && yarn run build

4. Use the green Run button to start the application.

To host the web version on your own infrastructure:

1. Deploy API: Set up NeteaseCloudMusicApi.
2. Clone Repository:

   git clone --recursive https://github.com/qier222/YesPlayMusic.git

3. Install Dependencies:

   yarn install

4. Configure Environment: Copy .env.example to .env. Set VUE_APP_NETEASE_API_URL to your API address.
   • If using a reverse proxy (e.g., Nginx) to map the API to /api, use /api.
   • For local development, use http://localhost:3000 (or your API port).
5. Build:

   yarn run build

6. Deploy: Upload the contents of the /dist directory to your web server.

The devServer configuration allows you to set the development port and proxy API requests. By default, it uses the DEV_SERVER_PORT environment variable or falls back to 8080. It includes a proxy rule for /api that redirects to http://localhost:3000 and rewrites the path by removing the /api prefix.

devServer: {
  disableHostCheck: true,
  port: process.env.DEV_SERVER_PORT || 8080,
  proxy: {
    '^/api': {
      target: 'http://localhost:3000',
      changeOrigin: true,
      pathRewrite: {
        '^/api': '/',
      },
    },
  },
}

The pwa object defines Progressive Web App properties, including the application name, icon paths, theme color, and manifest background color.

pwa: {
  name: 'YesPlayMusic',
  iconPaths: {
    favicon32: 'img/icons/favicon-32x32.png',
  },
  themeColor: '#ffffff00',
  manifestOptions: {
    background_color: '#335eea',
  },
}

You can provide custom webpack configurations specifically for the Electron Main process or the Renderer process via chainWebpackMainProcess and chainWebpackRendererProcess. This is useful for defining global constants like IS_ELECTRON or setting up specific loaders/aliases for each process.

pluginOptions: {
  electronBuilder: {
    // Configuration for the Main process
    chainWebpackMainProcess: config => {
      config.plugin('define').tap(args => {
        args[0]['IS_ELECTRON'] = true;
        return args;
      });
    },
    // Configuration for the Renderer process
    chainWebpackRendererProcess: config => {
      config.plugin('define').tap(args => {
        args[0]['IS_ELECTRON'] = true;
        return args;
      });
    }
  }
}