Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 2.89 KB

FrontEnd.md

File metadata and controls

28 lines (23 loc) · 2.89 KB

Tank Controller Manager

The Tank Controller Manager (TCM) works to monitor, operate, and consolidate multiple tank controllers. A tank controller regulates tank pH through CO2 addition and temperature. The purpose of the TCM is to allow over-the-network access to tank controllers while facilitating research by reporting data. Created in Flutter with the programming language Dart, the TCM runs on virtually every main platform.

Installation and Setup

  1. After forking the repository, install the Dart and Flutter SDKs following the instructions here: Dart and Flutter.
  2. If using an IDE such as VSCode, the Dart and Flutter extensions can be useful.
  3. The directory for the Tank Controller Manager is at extras/webClient, which is where you will want to run the majority of commands. All Dart files for the project are within this directory.
  4. For first time setup or when updating packages, run flutter pub get to load necessary packages for the project. With the Dart and Flutter extensions for VSCode, this will run automatically.
  5. The Google Chrome Browser is used to locally run and debug this project, and you can install it here: Chrome.
  6. Set Chrome as the default device for the project. With VSCode and the Dart/Flutter extensions, this can be set in the bottom right corner.
  7. The project can then be run locally using the command flutter run in the terminal, or with the IDE's run/debug commands.

Alternative Setup

As an alternative to the flutter run command, you can follow these instructions to create a local build.

  1. Open a terminal and run flutter build web
  2. Navigate to TankControllerManager/build/web and run python3 -m http.server 8000
  3. Open a web browser on localhost:8000.

Helpful Commands

  • dart analyze or flutter analyze to run the linter for the project.
  • flutter test --concurrency=1 to run the existing tests for the project. This can also be done automatically with the testing tab of your IDE, though concurrency may not be set to 1.
  • dart format [file path] can be used to format individual files. Your IDE may also have a formatting option. VSCode can do this with the Format Document option when right clicking.

Github

Github actions will automatically run the linter and all tests and check for formatting and spelling when a new commit is made or a pull request is submitted. As the repository is also shared with the code for the Tank Controller, tests for Arduino Lint, Arduino CI, and clang format will also be run at the same time, but should not be affected by the Tank Controller Manager project.

Deployment

The web application is built when a new release is created on GitHub and can be viewed here. Contact one of the maintainers to request a new release.