rngtrainer_frontend

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Project Setup
3. Roadmap

About The Project

Built With

• Flutter

Getting Started

Prerequisites

Option 1: Using docker!

The easiest way to get the frontend running is by using Visual Studio Code and its extensions + Docker. With docker you don't need to install the Flutter and Android SDK on your developer machine.

• Install Visual Studio Code
• Install Docker

Inside VsCode, install following extensions:

• Docker extension
• Remote Development

The configuration for the dockerfile can be found in the following repository file: Configuration of dockerfile.

For debugging, the following chrome extension is needed: Chrome Debug Extension. After installing that please navigate to lib/main.dart and press F5. This will launch a new browser tab and you have to click the Dart debug plugin to finally open the app.

Option 2: Get it run without docker!

• Install Visual Studio Code

Inside VsCode, install following extensions:

• Dart
• Flutter

Use the following command in the terminal to check wheter flutter is installed correctly.

flutter doctor -v

Project Setup

Step 1: Download or clone this repo by using the link below:

https://github.com/Master-Project-RNG/rgntrainer_frontend.git

Step 2: Open the project folder in VScode.

If you run your application with the help of the container, click on the green button on the left buttom corner.

Then choose Remote - Containers: Reopen in Container

Step 3 : Go to project root and execute the following command in console to get the required dependencies:

flutter pub get 

Step 4: Befor starting the frontend, make sure that the backend is running. Change the api BASE URL in host.dart so that it accesses a running backend.

Step 5: Start the application.

Wihtout container

flutter run -d chrome

With container

`Press F5` in main.dart

Roadmap

See the open issues for a list of proposed features (and known issues).