feat: Improve new Serverpod project template (serverpod#3408)

Co-authored-by: Viktor Lidholt <[email protected]>

Author: dkbast

.fvmrc

@@ -0,0 +1,3 @@
+{
+  "flutter": "3.19.0"
+}

.gitignore

@@ -38,3 +38,7 @@ templates/serverpod_templates/projectname_flutter/android
 templates/serverpod_templates/projectname_flutter/ios
 templates/serverpod_templates/projectname_flutter/macos
 templates/serverpod_templates/projectname_server/deploy/gcp/.terraform
+templates/serverpod_templates/projectname_client/lib/src/
+templates/serverpod_templates/projectname_server/lib/src/generated/
+templates/serverpod_templates/projectname_server/test/integration/test_tools/
+templates/serverpod_templates/projectname_server_upgrade/test/

templates/serverpod_templates/projectname_client/analysis_options.yaml

@@ -9,5 +9,5 @@
 #     - camel_case_types
 
 analyzer:
-#   exclude:
-#     - path/to/excluded/files/**
+  exclude:
+    - lib/src/protocol/**

templates/serverpod_templates/projectname_client/doc/endpoint.md

@@ -5,8 +5,8 @@ Each class contains callable methods that will call a method on the server side.
 Example usage:
 
 ```dart
-// How to use ExampleEndpoint.
-client.example.hello("world!");
+// How to use GreetingEndpoint.
+client.greeting.hello("world!");
 
 // Generic format.
 client.<endpoint>.<method>(...);

templates/serverpod_templates/projectname_client/lib/src/protocol/client.dart

@@ -24,6 +24,5 @@ linter:
   rules:
     # avoid_print: false  # Uncomment to disable the `avoid_print` rule
     # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
-
 # Additional information about this file can be found at
 # https://dart.dev/guides/language/analysis-options

templates/serverpod_templates/projectname_client/lib/src/protocol/example.dart

@@ -2,15 +2,30 @@ import 'package:projectname_client/projectname_client.dart';
 import 'package:flutter/material.dart';
 import 'package:serverpod_flutter/serverpod_flutter.dart';
 
-// Sets up a singleton client object that can be used to talk to the server from
-// anywhere in our app. The client is generated from your server code.
-// The client is set up to connect to a Serverpod running on a local server on
-// the default port. You will need to modify this to connect to staging or
-// production servers.
-var client = Client('http://$localhost:8080/')
-  ..connectivityMonitor = FlutterConnectivityMonitor();
+/// Sets up a global client object that can be used to talk to the server from
+/// anywhere in our app. The client is generated from your server code
+/// and is set up to connect to a Serverpod running on a local server on
+/// the default port. You will need to modify this to connect to staging or
+/// production servers.
+/// In a larger app, you may want to use the dependency injection of your choice instead of
+/// using a global client object. This is just a simple example.
+late final Client client;
+
+late String serverUrl;
 
 void main() {
+  // When you are running the app on a physical device, you need to set the
+  // server URL to the IP address of your computer. You can find the IP
+  // address by running `ipconfig` on Windows or `ifconfig` on Mac/Linux.
+  // You can set the variable when running or building your app like this:
+  // E.g. `flutter run --dart-define=SERVER_URL=https://api.example.com/`
+  const serverUrlFromEnv = String.fromEnvironment('SERVER_URL');
+  final serverUrl =
+      serverUrlFromEnv.isEmpty ? 'http://$localhost:8080/' : serverUrlFromEnv;
+
+  client = Client(serverUrl)
+    ..connectivityMonitor = FlutterConnectivityMonitor();
+
   runApp(const MyApp());
 }
 
@@ -39,22 +54,24 @@ class MyHomePage extends StatefulWidget {
 }
 
 class MyHomePageState extends State<MyHomePage> {
-  // These fields hold the last result or error message that we've received from
-  // the server or null if no result exists yet.
+  /// Holds the last result or null if no result exists yet.
   String? _resultMessage;
+
+  /// Holds the last error message that we've received from the server or null if no
+  /// error exists yet.
   String? _errorMessage;
 
   final _textEditingController = TextEditingController();
 
-  // Calls the `hello` method of the `example` endpoint. Will set either the
-  // `_resultMessage` or `_errorMessage` field, depending on if the call
-  // is successful.
+  /// Calls the `hello` method of the `greeting` endpoint. Will set either the
+  /// `_resultMessage` or `_errorMessage` field, depending on if the call
+  /// is successful.
   void _callHello() async {
     try {
-      final result = await client.example.hello(_textEditingController.text);
+      final result = await client.greeting.hello(_textEditingController.text);
       setState(() {
         _errorMessage = null;
-        _resultMessage = result;
+        _resultMessage = result.message;
       });
     } catch (e) {
       setState(() {
@@ -89,7 +106,7 @@ class MyHomePageState extends State<MyHomePage> {
                 child: const Text('Send to Server'),
               ),
             ),
-            _ResultDisplay(
+            ResultDisplay(
               resultMessage: _resultMessage,
               errorMessage: _errorMessage,
             ),
@@ -100,13 +117,14 @@ class MyHomePageState extends State<MyHomePage> {
   }
 }
 
-// _ResultDisplays shows the result of the call. Either the returned result from
-// the `example.hello` endpoint method or an error message.
-class _ResultDisplay extends StatelessWidget {
+/// ResultDisplays shows the result of the call. Either the returned result from
+/// the `example.greeting` endpoint method or an error message.
+class ResultDisplay extends StatelessWidget {
   final String? resultMessage;
   final String? errorMessage;
 
-  const _ResultDisplay({
+  const ResultDisplay({
+    super.key,
     this.resultMessage,
     this.errorMessage,
   });
@@ -126,11 +144,13 @@ class _ResultDisplay extends StatelessWidget {
       text = 'No server response yet.';
     }
 
-    return Container(
-      height: 50,
-      color: backgroundColor,
-      child: Center(
-        child: Text(text),
+    return ConstrainedBox(
+      constraints: const BoxConstraints(minHeight: 50),
+      child: Container(
+        color: backgroundColor,
+        child: Center(
+          child: Text(text),
+        ),
       ),
     );
   }

templates/serverpod_templates/projectname_client/lib/src/protocol/protocol.dart

@@ -19,10 +19,10 @@ include: package:lints/recommended.yaml
 #   rules:
 #     - camel_case_types
 
-# analyzer:
-#   exclude:
-#     - path/to/excluded/files/**
-
+analyzer:
+  exclude:
+    - lib/src/generated/**
+    - test/integration/test_tools/serverpod_test_tools.dart
 # For more information about the core and recommended set of lints, see
 # https://dart.dev/go/core-lints
 

templates/serverpod_templates/projectname_flutter/analysis_options.yaml

@@ -3,7 +3,7 @@ import 'package:serverpod/serverpod.dart';
 import 'src/generated/protocol.dart';
 import 'src/generated/endpoints.dart';
 
-// This is the starting point of your Serverpod server.
+/// The starting point of the Serverpod server.
 void run(List<String> args) async {
   // Initialize Serverpod and connect it with your generated code.
   final pod = Serverpod(