Skip to content

Latest commit

 

History

History
272 lines (197 loc) · 7.51 KB

README.md

File metadata and controls

272 lines (197 loc) · 7.51 KB
Raw

Scénická žatva app

Open-Source Festival-app written in Flutter for iOS & Android (and possibly web).

Codemagic build status

Dependencies

Flutter

Flutter is the glue that make creating a universal app (iOS + Android) possible. Check it out , it's pretty awesome.

Updating icon

Icon

Replace the icon.png located assets/images/icon.png & run the following command.

flutter pub run flutter_launcher_icons:main

Moreover I needed to generate icons for iOS at https://www.appicon.co/ and upload them to

ios/Runner/Assets.xcassets/AppIcon.appiconset

Updating splash screen

Splash

Replace the splash.png located assets/images/splash.png & run the following command.

flutter pub run flutter_native_splash:create

Try to keep the dimensions the same, so that it will show on all device-resolutions. The current one uses an iPhone SE as a baseline.

Make sure to upload the image with an alpha and change the background color in pubspec.yaml.

flutter_native_splash:
  image: assets/images/splash.png
  color: "#021f2d" <- Change this to your favorite background color

Folder structure

Here is the folder structure of our Flutter app. Flutter has generated an Android and iOS folder. If you open it you will see that they are normal ios & android projects.

But since we use Flutter, we mostly care about the lib-folder.

.
├── android
│   ├── app
│   └── gradle
├── assets
│   └── images
├── build
│   ├── flutter_assets
│   └── ios
├── ios
│   ├── Flutter
│   ├── Runner
│   ├── Runner.xcodeproj
│   └── Runner.xcworkspace
├── lib
│   ├── models
│   ├── pages
│   ├── providers
│   ├── requests
│   ├── views
│   └── widgets
├── resources
├── test
└── web

Lib-folder

Let's take a closer look at the lib-folder.

lib
├── main.dart
├── models
├── pages
├── providers
├── requests
├── views
└── widgets

Main.dart

Right inside the lib-folder you find the main.dart. This is where the whole app gets setup and started.

You can se that we are wiring up our Providers at the root build-method of our app. This makes it easy for our widgets to share some state. Take a look at this video by Paul Halliday for an introduction to providers.

https://www.youtube.com/watch?v=8II1VPb-neQ

He is here also talking about bloc, but I don't think he actually is using the bloc-pattern... Anyways. It's a great video that made Providers easy for me to understand.

Models

A model is a class that represents the data we want to show in the app. It helps us in making sure that we use our data in a way that makes sense.

That was a bit abstract... Talk to Henry if you have any questions. Or update this readme with a better explanation. Thank you.

models
├── Arrangement.dart
├── Event.dart
├── InfoPost.dart
└── NewsPost.dart

Tip: Use the amazing JSON to Dart-converter by Javier Lecuona to generate dart classes from your JSON.

Pages

This is where we put whole "fully-scaffolded" pages.

pages
├── DetailPage.dart
├── EventDetailPage.dart
├── InfoDetailPage.dart
├── NewsDetailPage.dart
├── TabPage.dart
└── counter.dart

See https://flutter.dev/docs/cookbook/navigation/navigation-basics for a good introduction to navigation.

Providers

This is the famous provider. Makes it easy to share state up and down the application-tree cross widgets.

providers
├── AppSettings.dart
├── ArrangementProvider.dart
├── EventProvider.dart
├── EventsProvider.dart
├── InfoProvider.dart
├── NewsProvider.dart
└── counter_bloc.dart

Todo: Write an introduction

Requests

This is where we add all our api-endpoints. Currently we only have one api, that we simply call api.dart. But in the future, we may have a api weather.dart.

requests
└── api.dart

The api is connected to a provider that takes the data and makes objects with our models, then provides that data to all our other widgets.

Views

This is where we add our, you guessed it, Views. A View is a combination of multiple Widgets.

A View needs to be shown inside a Page since it lacks the scaffolding that is needed for making it a page.

views
├── CalendarView.dart
├── InfoView.dart
├── IntroView.dart
└── NewsView.
dart

Widgets

Widgets, widgets, widgets.

This is the place to keep all our custom widgets.

widgets
├── FrostedButton.dart
├── decrement.dart
├── increment.dart
└── toggleTheme.dart

Contribution guide

Properly naming branches

When creating a new feature or solving an issue. Create a new branch f/<featurename> We use f/ for features bf/ for bugfix etc... It doesn't matter that much as long as it makes sense.

PR

Then create a pull request aka. PR here on GitHub and assign me (sjoenH) or the utvikler-team as a reviewer. Assigning the utvikler-team will do some load-balancing, auto assigning someone in the team.

Your branch should be merged into the develop-branch (not straight into master). We only have production code in master-branch. We may delete the feature-branch after it has been merged into develop.

Publishing a new version

Make a PR from develop into master and tag your code. For example.

git tag v1.0.0
git push origin v1.0.0

Tagging a release should trigger a new build on Codemagic. Codemagic build status

Other stuff to remember

iOS screenshots to add when submitting to App Store

https://help.apple.com/app-store-connect/#/devd274dd925

Devices:

  • 6.5 inch (iPhone 11 Pro Max)
  • 5.5 inch (iPhone 8 Plus)
  • 12.9 inch (3rd generation iPad Pro)
  • 12.9 inch (2nd generation iPad Pro)

I use this service to generate nice mockups https://studio.app-mockup.com/

Generate native libs for play console

Go to [YOUR_PROJECT]\build\app\intermediates\merged_native_libs\release\out\lib

note that 3 folders exist inside

arm64-v8a
armeabi-v7a
x86_64

Select this 3 folder and create a .zip file. Name doesn't matter.

[PLEASE NOTE THAT I HAVEN'T COMPRESSED THE ./lib FOLDER]

Upload this new *.zip file as Symbol File.