Move database to seperate package

This commit is contained in:
Elias Projahn 2020-04-24 22:41:52 +02:00
parent 939840d95f
commit 7e25880cc5
28 changed files with 98 additions and 24 deletions

View file

@ -4,8 +4,38 @@ The classical music player and organizer.
https://musicus.org
## Project structure
The top level directories contain the main Musicus packages, of which some
depend on other ones. All packages are written in [Dart](https://dart.dev).
### `database`
A Database of classical music. This package will be used by all standalone
Musicus applications for storing classical music metadata.
### `mobile`
The Musicus mobile app. It is being developed using
[Flutter toolkit](https://flutter.dev) and only runs on Android for now.
### `player`
The simplest possible audio player plugin. This is used by the mobile app for
playback.
## Hacking
Picking up Dart as a programming language and Flutter as an UI toolkit should
be relatively straight forward. You can visit
[this page](https://flutter.dev/docs/get-started/install) to get started with
Flutter. After cloning the Musicus repository, it works best to work at its
subcomponents one at a time. I recommend
[VS Code](https://flutter.dev/docs/get-started/editor?tab=vscode) for editing.
Please contact me via e-mail (see my profile), if you have any questions or
need help. I'm also open to ideas for the future of Musicus! Please use the
issue tracker for them.
You can use the following command to automatically update generated code while
working on Musicus: