Skip to content

The server backend for a web based interactive Dart service

License

Notifications You must be signed in to change notification settings

grida-research/dart-services

 
 

Repository files navigation

Dart Services

A server backend to support DartPad.

Build Status Coverage Status Uptime Status Gitpod Ready-to-Code

Bridged override implementation

Read more at override

What is it? What does it do?

This project is a small, stateless Dart server, which powers the front-end of DartPad. It provides many of DartPad's features, including static analysis (errors and warnings), compilation to JavaScript, code completion, dartdoc information, code formatting, and quick fixes for issues.

Getting set up

This project is built with grinder. To install, please run:

pub global activate grinder

The dart-services v2 API is defined in terms of Protobuf, which requires the installation of the Protobuf protoc compiler. Please see Protocol Buffers for detailed instalation instructions.

The Dart protoc plugin is also required for the above protoc compiler to generate Dart code. To install, please run:

pub global activate protoc_plugin

Running

To run the server, run:

dart bin/server_dev.dart --port 8082

The server will run from port 8082 and export several JSON APIs, like /api/compile and /api/analyze.

Testing

Flutter is bundled with the project and requires the following commands to be executed to configure the bundled version:

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

or:

grind deploy for all tests and checks.

dart-services requires the redis package, including the redis-server binary, to be installed to run tests. sudo apt-get install redis-server will install this on Ubuntu, but see Redis' Quick Start guide for other platforms.

Deploying

To deploy the server to Dart on AppEngine, follow the instructions here.

Modify warmup.dart to point the BASE_URI to your AppEngine project.

Then run

./tool/deploy.sh

The will deploy the server, and run the warmup sequence and sanity checks.

Related projects

See also the dart-pad repo.

Issues and bugs

Please file reports on the GitHub Issue Tracker for DartPad.

License and Contributing

Contributions welcome! Please read this short guide first. You can view our license here.

About

The server backend for a web based interactive Dart service

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 96.4%
  • Dockerfile 1.4%
  • Other 2.2%