https://github.com/sentrionic/valkyrieapp

The Flutter app for https://valkyrieapp.xyz
https://github.com/sentrionic/valkyrieapp

bloc dart ddd-architecture flutter fullstack websocket

Last synced: about 14 hours ago
JSON representation

The Flutter app for https://valkyrieapp.xyz

• Host: GitHub
• URL: https://github.com/sentrionic/valkyrieapp
• Owner: sentrionic
• License: mit
• Created: 2021-03-26T14:26:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-21T16:24:33.000Z (about 1 year ago)
• Last Synced: 2024-11-12T05:36:52.909Z (3 days ago)
• Topics: bloc, dart, ddd-architecture, flutter, fullstack, websocket
• Language: Dart
• Homepage: https://github.com/sentrionic/Valkyrie
• Size: 15.3 MB
• Stars: 40
• Watchers: 3
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ValkyrieApp

The mobile application for [Valkyrie](https://github.com/sentrionic/Valkyrie) written in Flutter.

For the APK check out the [Release tab](https://github.com/sentrionic/ValkyrieApp/releases).

## Screenshots

  

    

    

    

    

    

    

    

    

    

    

  

  

## Stack

- Flutter

- [Bloc and Cubit](https://bloclibrary.dev/#/) for state management

- [get_it](https://pub.dev/packages/get_it) for dependency injection

- REST for data fetching and websockets for real time events

For all features check out the parent [repository](https://github.com/sentrionic/Valkyrie).

For the socket.io version check out the `v1` branch.

The architecture of this app is based on Reso Coder's [Domain Driven Design Principles](https://resocoder.com/2020/03/09/flutter-firebase-ddd-course-1-domain-driven-design-principles/):

![DDD architecture](https://resocoder.com/wp-content/uploads/2020/03/DDD-Flutter-Diagram-v3.svg)

> **Application** contains all the Use Cases

> **Domain** contains the business logic (entities and validation)

> **Infrastructure** contains the repositories and network calls as well as Data Transfer Objects

> **Presentation** contains all the UI components and the web sockets

## Installation

This app was created and tested on `Flutter 3.0.0` and `Dart 2.17.0` .

```

git clone https://github.com/sentrionic/ValkyrieApp.git

cd ValkyrieApp

flutter packages get

```

For debug mode run `flutter run` and for production mode run `flutter run --release`

To run the code generator using `freezed`, run `flutter pub run build_runner watch --delete-conflicting-outputs`.

If you want to use your own server you will need to change the `BaseUrl` in `InjectableModule`.

If said server runs locally you will also need to add `android:usesCleartextTraffic="true"` to the Android manifest.

**Note**: Instead of `localhost` you need to specify your `IPv4 Address` (e.g. `192.168.2.xxx`), otherwise the HttpClient won't be able to connect to the server.

## Tests

Tests were written for all Use Cases in the `Application` directory and the repositories and DTOs in the `Infrastructure` directory.

To run all tests run `flutter test`

## Additional Information

This app was tested and is working on Android and the general design is based on Discord's Android version.

The iOS version will need additional configuration done to the packages to run.

As I do not own a Mac I cannot work on it.

## Credits

[Reso Coder](https://resocoder.com/): This app's structure is based on his DDD tutorial and the tests are based on his TDD tutorial.