= a·muse
apiote
v0.1.0 (Agrajag) 2019-12-19
:toc:
a·muse is a no-JavaScript frontend for The Movie Database. It is also a system that connects films with books which the former are based on, thanks to using data from Wikidata. Finally, a·muse is also a place to collect ideas which films, books, and series watch or read next, and which of those have already been watched or read.
Primary instance runs at https://amuse.apiote.tk
== Name
The name of the system is ‘a·muse.’ The name of the program, command, any package is ‘amuse.’
Both are pronounced the same–[æˈʔmjuːz].
It’s a play of words—amuse as a verb, and a muse as a goddess.
== Building
To build version 0.1.x, You need:
* `go>=1.11`
* Inkscape
* `cwebp`
* `make` or `mk`
From version 0.2.0, `make` will not be supported, `resvg` will be supported alongside Inkscape.
=== Python router
Because `apiote.tk` runs currently on a shared hosting with no possibility of running arbitrary binaries, but with wsgi, a·muse can be built as a Python module and run with a Python router. This only works with `glibc` (https://github.com/golang/go/issues/13492[Github issue]). Furthermore, the shared hosting uses `python==3.7` so a friendly `Dockerfile` is provided.
Build script is only provided in the `mkfile`, not in the `makefile`.
*This is a hack. You are on Your own.*
== Contribute
Contributions are welcome either as merge requests or patches (send patches to `git@apiote.tk`).
If You want to translate a·muse, translate strings in `i18n/default.toml` and request merge, send patch, or share the translated file in any other way. The translated file must be named `tag.toml`, where `tag` is the language tag of the translation. Translations don’t have to be full; a·muse falls back to default (en-GB) when strings are missing.
This project uses https://nvie.com/posts/a-successful-git-branching-model/[nvie’s branching model]. Please request merges to `develop` branch.
== Roadmap
v0.2.0::
* Search and show books
* Show book that film/serie is based on
* Add API
* UI enhancements
* Recommendations
* Last aired episode
v0.3.0::
* Mark to watch, to read
* Mark watched, read
== Licence
----
amuse Copyright (C) 2019 apiote
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
----