get_server 0.11.0
get_server: ^0.11.0

Dart native
Flutter Android iOS

A backend server that makes it possible to program with Flutter syntax and reuse existing code

Get Server #

The first backend/frontend/mobile framework written in one syntax for Android, iOS, Web, Linux, Mac, Windows, Fuchsia, and backend.

GetX is the most popular framework for Flutter, and has gained great engagement in the community for facilitating development to the extreme, making the most complex things of Flutter simple. However, many developers start at Flutter/GetX without any basis in the backend, and are forced to learn another stack, another language, to build their APIs. GetX fulfilling its mission of transforming development into something simple and productive, created its own server with almost 100% use of the frontEnd code. If you have a local database written in dart (like Hive and Sembast), you can turn it into a backend and build your api to provide them with a simple copy and paste. All of your Model classes are reused. All its route syntax is reused. All of your business logic is reused, and your visualization can be easily exchanged for your API, with a few lines of code.

Getting Started #

This project is still in beta, your contribution will be very welcome for the stable launch.

Installing

Add Get to your pubspec.yaml file:

dependencies:
  get_server:

Import get in files that it will be used:

import 'package:get_server/get_server.dart';

To create a server, and send a message:

void main() {
  runApp(GetServer(
    getPages: [
      GetPage(name: '/', page:()=> Home()),
    ],
  ));
}

class Home extends GetView {
  @override
  Widget build(BuildContext context) {
    return Text("Welcome to GetX");
  }
}

This is stupidly simple, you just define the path of your URL, and the page you want to deliver!

What if you want to return a json page?

class Home extends GetView {
  @override
  Widget build(BuildContext context) {
    return Json({
      "fruits": ["banana", "apple", "orange"]
    });
  }
}

Ok, you created your project with Flutter web, and you have no idea how to host it on a VPS, would it be possible to create the API for your application, and use the same GetX to display the Flutter web project? Yep. You need only copy your web folder from Flutter project, and paste on directory from server file. Flutter web generates an html file that calls a js file, which in turn requests several files that must be in a public folder. To make the Flutter web folder a public folder, just add it to your GetServer. That way when you enter your server, you will automatically be directed to the generator site with Flutter.

void main() {
  runApp(GetServer(
    public: Public('web'), // turn web folder public
    getPages: [
      GetPage(name: '/api', page:()=> HomeApi()),
    ],   
  ));
}

If you have an html that does not call files from the server, but only external files, you can use the Html widget for a specific path.

class Home extends GetView {
  @override
  Widget build(BuildContext context) {
    final path = '${Directory.current.path}/web/index.html';
    return Html(path);
  }
}

Ok, but what if I want to do a POST method to send a photo to my server, for example, how do I do this?

Okay, that sounds crazy, but you upload the file to your server, and retrieve it with an "upload.data". For the example not to be small, I will return a json response with the name of the file, his mimeType, and the same file back decoded in base64 so the example doesn't have just 5 lines.

class Home extends GetView {
  @override
  Future<Widget> build(BuildContext context) async {
    final upload = await context.file('file');
    final data = {
      "nameFile": upload.name,
      "mimeType": upload.mimeType,
      "fileBase64": "${base64Encode(upload.data)}",
    };
    return Json(data);
  }
}

How about Authentication? We have this as well.

First define a secret for your JWT:

void main() {
  runApp(
   GetServer(
    jwtKey: 'your key here',
   ),
  );
}

Second, retrieve your token:

final claimSet = JwtClaim(
  expiry: DateTime.now().add(Duration(days: 3)),
  issuer: 'get is awesome',
  issuedAt: DateTime.now(),
);

var token = TokenUtil.generateToken(claim: claimSet);

and finally just flag your routes that need the token to work:

GetPage(
  name: '/awesome-route',
  method: Method.get,
  page: () => YourPage(),
  needAuth: true,
),

I'm still not convinced, this is just an http server, but what if I want to create a chat that has real-time communication, how would I do that?

Okay, today is your lucky day. This is not just an http server, but also a websocket server.

class SocketPage extends GetView {
  @override
  Widget build(BuildContext context) {
    return Socket(context, builder: (socket) {
    
      socket.onMessage((data) { // message based
        socket.send(data); // echo
      });

      socket.on('join', (val) { // event based
        socket.join(val); // join to group
      });

      socket.onOpen((ws) {
        print('new socket opened'); // called when socket is open
      });

      socket.onClose((ws) {
        print('socket has been closed. Motivo: ${ws.message}');
      });
    });
  }
}

Dart is not popular for servers, however, attracting people who already program in Flutter to the backend is now also a mission of GetX. Transforming one-dimensional programmers into full stack developers with 0% learning curve, and reusing code is also one of GetX's goals, and I hope you will help us on this journey.

Like most of the "node.js" way? #

The purpose of this package is to make development for Flutter developers easier. However, the javascript ecosystem is very large and you may be used to a more functional syntax. With get_server you can use this path. You can use get_server as well:

void main() {
  final app = GetServer();
  app.get('/', (res) => res.send('Get_server of javascript way'));
  app.ws('/socket', (res) {
    res.ws.listen((socket) {
      socket.onMessage((data) {
        print('data: $data');
      });

      socket.onOpen((ws) {
        print('new socket opened');
      });

      socket.onClose((ws) {
        print('socket has been closed');
      });
    });
  });
  app.start();
}

How can you help? #

  • Creating Pull requests, adding resources, improving documentation, creating sample applications, producing articles, videos about Getx, suggesting improvements, and helping to disseminate this framework in development communities.
  • Supporting this project.

TODO:

  • Add Auth options.
  • Remove requirements dart:mirrors to allow people to compile the server and use only the binary, protecting its source code.
  • Add some ORM
  • Create a dart SDK script installation to make it easier to install get_server on servers.
  • Creation of Bindings and Controllers (as in the main GetX) to adapt the project 100% with Getx for frontend.

Accessing GetX: #

GetX starts by default on port 8080. This was done to, if you want to install a reverse proxy like nginx, do it without much effort.

You could, for example, access the home page created in this example, using:

http://localhost:8080/ or http://127.0.0.1:8080/

However, if you want to start it on another port, such as 80, for example, you can simply do:

void main() {
  runApp(GetServer(
    port: 80,
    getPages: [
      GetPage(name: '/', page:()=> Home()),
    ],
  ));
}

To SSL you have too the certificateChain, privateKey, and password, configurations on GetServer

109
likes
80
pub points
73%
popularity

Publisher

getx.site

A backend server that makes it possible to program with Flutter syntax and reuse existing code

Repository (GitHub)
View/report issues

Documentation

API reference

License

Apache 2.0 (LICENSE)

Dependencies

get_instance, get_rx, http_server, jaguar_jwt, meta, mime

More

Packages that depend on get_server