Claudio Ortolina
7ffd0c375b
- Add intro - Add setup instructions - Remove obsolete dev notes - Remove db queries (they're in the repo's livebook)
41 lines
1.8 KiB
Markdown
41 lines
1.8 KiB
Markdown
# Music Library
|
|
|
|
Music Library is an application to manage a collection of music records in different physical formats.
|
|
|
|
## Features
|
|
|
|
- Import records from MusicBrainz, with optional override of specific pieces of data
|
|
- Manage a collection and a wishlist of records, with ways to quickly search and filter based on records' metadata
|
|
- Integration with Last.fm (display latest scrobbles, and where possible connect them with records in the collection or wishlist)
|
|
- Some basic stats
|
|
- All data stored in a single SQLite database for portability and ease of backup/restore
|
|
- Ideal for deployment on a server with limited resources (1CPU, 512MB RAM)
|
|
|
|
## Setup
|
|
|
|
To start your Phoenix server:
|
|
|
|
- Run `mix setup` to install and setup dependencies
|
|
- Setup necessary environment variables:
|
|
- `LAST_FM_USER`: the Last.fm username used to populate the Scrobble Activity
|
|
- `LAST_FM_API_KEY`: the Last.fm API key used to fetch the Scrobble Activity
|
|
If using `direnv`, one can create a `.envrc.local` file for configuration variables, and a `.secrets` file for secrets. Both are automatically sourced via the `.envrc` file in the repo.
|
|
- Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
|
|
|
|
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser. The default password for development is `change me`.
|
|
|
|
The application is setup for deployment on Fly.io.
|
|
|
|
### CI
|
|
|
|
See the `.github` folder.
|
|
|
|
## Favicons
|
|
|
|
This favicon was generated using the following graphics from Twitter Twemoji:
|
|
|
|
- Graphics Title: 1f4bd.svg
|
|
- Graphics Author: Copyright 2020 Twitter, Inc and other contributors (<https://github.com/twitter/twemoji>)
|
|
- Graphics Source: <https://github.com/twitter/twemoji/blob/master/assets/svg/1f4bd.svg>
|
|
- Graphics License: CC-BY 4.0 (<https://creativecommons.org/licenses/by/4.0/>)
|