Document Flutter setup (#639)
diff --git a/README.md b/README.md
index 1367799..d34d074 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@
This project is built with [grinder](https://pub.dev/packages/grinder). To install, please run:
```bash
-pub global activate grinder
+$ pub global activate grinder
```
The dart-services v2 API is defined in terms of Protobuf, which requires
@@ -31,7 +31,25 @@
to generate Dart code. To install, please run:
```bash
-pub global activate protoc_plugin
+$ pub global activate protoc_plugin
+```
+
+## Initialise Flutter
+
+The Flutter submodule in the git repo needs to also be downloaded and setup.
+
+```bash
+$ git submodule update --init
+$ ./flutter/bin/flutter doctor -v
+$ ./flutter/bin/flutter/bin/flutter config --enable-web
+```
+
+## Build the subsidiary files
+
+The Dart Services server depends on generated files. Run the following to generate all the required binaries.
+
+```bash
+$ grind deploy
```
## Running
@@ -39,7 +57,7 @@
To run the server, run:
```bash
-dart bin/server_dev.dart --port 8082
+$ grind serve
```
The server will run from port 8082 and export several JSON APIs, like
@@ -47,14 +65,6 @@
## Testing
-Flutter is bundled with the project and requires the following commands to be executed to configure the bundled version:
-
-```bash
-flutter/bin/flutter doctor
-flutter/bin/flutter config --enable-web
-flutter/bin/flutter precache --web --no-android --no-ios --no-linux --no-windows --no-macos --no-fuchsia
-```
-
To run tests:
`grind test` for unit tests
