Git Product home page Git Product logo

flamepad-services's Introduction

Dart Services

A server backend to support DartPad.

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

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:

$ dart 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 installation instructions. On macOS, you may also install with Homebrew via:

$ brew install protobuf

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

$ dart pub global activate protoc_plugin

Initialise Flutter

The Flutter SDK needs to be downloaded and setup.

$ dart pub install
$ dart run tool/update_sdk.dart

Build the subsidiary files

The Dart Services server depends on generated files. Run the following to generate all the required binaries.

$ grind deploy

Running

To run the server, run:

$ grind serve

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

Testing

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.

flamepad-services's People

Contributors

allentv avatar devoncarew avatar domesticmouse avatar franklinyow avatar georgehe4 avatar gmosx avatar gspencergoog avatar himanshuranjan30 avatar jakemac53 avatar jakobr-google avatar jcollins-g avatar johnpryan avatar jonasfj avatar kasperpeulen avatar kevmoo avatar lambdabaa avatar luanpotter avatar lukechurch avatar natebosch avatar parlough avatar redbrogdon avatar srawlins avatar wibling avatar wolfenrain avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.