navidrome/README.md

57 lines
2.1 KiB
Markdown
Raw Normal View History

2016-02-26 17:39:14 +01:00
GoSonic
2016-02-25 00:28:23 +01:00
=======
[![Build Status](https://travis-ci.org/deluan/gosonic.svg?branch=master)](https://travis-ci.org/deluan/gosonic) [![Go Report Card](https://goreportcard.com/badge/github.com/deluan/gosonic)](https://goreportcard.com/report/github.com/deluan/gosonic)
2016-02-26 16:56:57 +01:00
__This is still a work in progress, and has no releases available__
2016-02-25 19:51:20 +01:00
2016-02-25 00:28:23 +01:00
GoSonic is an application that implements the [Subsonic API](http://www.subsonic.org/pages/api.jsp), but instead of
having its own music library like the original [Subsonic application](http://www.subsonic.org), it interacts directly
with your iTunes library.
2016-02-25 01:23:04 +01:00
The project's main goals are:
2016-02-26 07:45:04 +01:00
2016-03-25 05:04:22 +01:00
* Be fully compatible with available [Subsonic clients](http://www.subsonic.org/pages/apps.jsp)
(actively being tested with
[DSub](http://www.subsonic.org/pages/apps.jsp#dsub),
[SubFire](http://www.subsonic.org/pages/apps.jsp#subfire) and
2016-02-26 16:56:57 +01:00
[Jamstash](http://www.subsonic.org/pages/apps.jsp#jamstash))
2016-02-29 20:16:51 +01:00
* Use all metadata from iTunes, so that you can keep using iTunes to manage your music
2016-03-25 05:04:22 +01:00
* Keep iTunes stats (play counts, last played dates, ratings, etc..) updated, at least on Mac OS X.
This allows smart playlists to be used in Subsonic Clients
* Help me learn Go ;) [![Gopher](https://blog.golang.org/favicon.ico)](https://golang.org)
2016-02-25 00:28:23 +01:00
2016-02-26 07:45:04 +01:00
2016-03-10 00:28:11 +01:00
### Supported Subsonic API version
2016-02-29 20:16:51 +01:00
2016-03-21 22:30:58 +01:00
I'm currently trying to implement all functionality from API v1.8.0, with some exceptions.
2016-03-10 18:03:08 +01:00
2016-03-10 00:28:11 +01:00
Check the (almost) up to date [compatibility chart](https://github.com/deluan/gosonic/wiki/Compatibility) for what is working.
2016-02-25 00:28:23 +01:00
2016-02-26 17:39:14 +01:00
### Development Environment
You will need to install [Go 1.6](https://golang.org/dl/)
2016-02-29 20:16:51 +01:00
2016-02-26 17:39:14 +01:00
Then install dependencies:
```
2016-03-25 17:53:23 +01:00
$ go get github.com/beego/bee # bee command line tool
$ go get github.com/Masterminds/glide # dependency manager
$ glide install
2016-02-26 17:39:14 +01:00
```
2016-02-29 20:16:51 +01:00
From here it's a normal [BeeGo](http://beego.me) development cycle. Some useful commands:
2016-02-26 17:39:14 +01:00
2016-02-27 09:35:01 +01:00
```bash
# Start local server (with hot reload)
$ bee run
2016-02-29 20:16:51 +01:00
# Run all tests
2016-03-25 17:53:23 +01:00
$ go test $(glide nv) -v
2016-02-27 09:35:01 +01:00
```
2016-02-26 17:39:14 +01:00
2016-02-25 00:28:23 +01:00
2016-03-13 17:33:40 +01:00
### Copying
2016-02-25 00:28:23 +01:00
2016-03-13 17:33:40 +01:00
GoSonic - Copyright (C) 2016 Deluan Cotts Quintao
2016-02-24 00:41:35 +01:00
2016-03-13 17:33:40 +01:00
The source code is licensed under GPL v3. License is available [here](/LICENSE)