Light

tenhobi / totally_not_chernobyl Goto Github PK

View Code? Open in Web Editor NEW

16.0 1.0 0.0 324 KB

My Bachelor's Thesis mobile game

License: MIT License

Kotlin 0.24% Shell 0.64% Swift 0.23% Objective-C 0.02% Dart 98.87%

fit-ctu game mobile-game cooperative-game dart flutter flutter-game

totally_not_chernobyl's Introduction

Totally Not Chernobyl

✨ About

This game is created as part of my Bachelor's Thesis in the Czech language. Due to that, I will not accept any PRs for now.

It uses Flutter framework by Google and Cloud Firestore for communication.

The code follows the Clean Architecture.

🚀 How to start

Installation

Following steps will tell you what to install and point you to useful resources:

Install Dart—that might not be required, but some external tools may use it.
Install Flutter and other required tools.
Install Dart & Flutter packages to your IDE.
Install Android Studio for Android and Xcode for iOS.
If required, set up an Android or iOS emulator.

Set Up

Also, before building the app, make sure to:

Add android/app/google-services.json file for Android, provided by Firebase.
Add ios/Runner/GoogleService-info.plist file for iOS, provided by Firebase.

Running

Run the app using the flutter run command.

To learn more, read about building and releasing an Android app or an iOS app.

Build

To build an Android apk, run flutter build apk. To create docs, run dartdoc --exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:io,dart:isolate,dart:math,dart:typed_data,dart,dart:ffi,dart:html,dart:js,dart:ui,dart:js_util'.

🔨 Tools

This section contains some more tools that might help you enhance your development experience.

scrcpy

This tool is useful for providing display and control of Android devices.

After connecting a phone with a USB, run:

scrcpy --window-title "Totally Not Chernobyl" --always-on-top

or for wireless use, run:

adb tcpip 5555
adb connect DEVICE_IP:5555
# then you can unplug
scrcpy --window-title "Totally Not Chernobyl" --always-on-top --bit-rate 2M --max-size 800

📃 License

Licensed under the MIT License.

totally_not_chernobyl's People

Contributors

Stargazers

Watchers

totally_not_chernobyl's Issues

Write how to start guide

Write notes about how to start to the readme.

It should be mentioned what is required to install, in which version and also individually commands to run. There should also be mention of how to run an emulator or how to run the app on mobile.

Flutter
Dart (SDK comes with Flutter)
VSCode / IntelliJ to inspect code
Commands to run build (with finished installation)
Running emulator / Running on mobile

There also might be some tech used in this project info:

Tech-stack
- Dart
- Flutter
- Rive
Architecture
- Clean Architecture
Tests
- Mockito
- Bloc Test

Set up project for BLoC

Set up project for package:bloc and package:flutter_bloc.

TODO:

read again all matherial about BLoC
set up db using BLoC (#8)

Set up project before publishing

CI enhance

In main CI, do this improvements (Android):

Add a google-services.json file
Try to build apk (?)

Set up project for Firebase

Set up all necessary content for Cloud Firestore.

packages
using it through BLoC (#7)
example

Launcher icons

Add this package https://pub.dev/packages/flutter_launcher_icons to make managing app icons easy.

Localization

Investigate localization options for Flutter.

Simple package i69n seems easy to use.

Allow only landscape

Allow only landscape app. There is a solution from Flutter - find what it is.

Make up a name

For the project release etc. we need to make up a name for the game. Every recommendation is welcome.

Some ideas from people: (the list will be updated)

Keep hacking
Hack it!

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.