https://github.com/mitchray/ample

A simple web browser client for Ampache
https://github.com/mitchray/ample

ampache svelte wavesurfer

Last synced: 6 days ago
JSON representation

A simple web browser client for Ampache

• Host: GitHub
• URL: https://github.com/mitchray/ample
• Owner: mitchray
• License: agpl-3.0
• Created: 2021-08-29T05:36:47.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-20T21:37:57.000Z (16 days ago)
• Last Synced: 2024-10-21T10:29:31.853Z (16 days ago)
• Topics: ampache, svelte, wavesurfer
• Language: Svelte
• Homepage: https://ample-player.vercel.app/
• Size: 3.46 MB
• Stars: 62
• Watchers: 5
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
## _Ample_: A web browser client for [Ampache](https://ampache.org/) v6+



## Demo

[View demo](https://ample-player.vercel.app)

## Installing

1. Download Ample

    - Either from a prebuilt [release](https://github.com/mitchray/ample/releases)

    - or compile yourself from Git repository (see [Developing](#developing))

2. Place it anywhere on your server

    - Even on a different server from Ampache, just be mindful that the remote Ampache server will need [configuring]()

3. Set up the [config file](#config-file)

## Translations

Edit or add new languages via [Inlang Fink](https://inlang.com/editor/github.com/mitchray/ample)

## Config file

Save as `config/ample.json`, must be valid JSON (i.e. no trailing comma on the last item)

| Key             | Type     | Description                                                                         |

| --------------- | -------- | ----------------------------------------------------------------------------------- |

| ampacheURL      | Required | Full URL to the Ampache server                                                      |

| guestUserAPIKey | Optional | Login with this user's API key (use lowest Guest level permissions, this is public) |

| loginMessage    | Optional | Will be displayed on the login screen                                               |

| logo            | Optional | Use custom image on the login screen (full URL or relative path to Ample folder)    |

Example

```

{

  "ampacheURL": "https://example.com",

  "guestUserAPIKey": "123456789",

  "loginMessage": "There's no place like 127.0.0.1",

  "logo": "./config/logo.svg"

}

```

## Developing

-   Clone the Ample repository and from the ample directory `cd ample`

-   Install packages `npm install`

-   For development and hot reloading `npm run dev`

-   For building `npm run build`, and see the contents of `dist`

Additional console logging can be enabled by setting `debugMode true` in `src/stores/state.js`