Skip to content

Folder structure

Benjamin Eder edited this page Dec 15, 2018 · 7 revisions

I guess you are here for details about the projects folder structure! This page is only about the contents of the lib folder in the projects root.

Note that this structure may change in the future! If you notice discrepancies please open an issue!

...
lib/                  // Contains all the source code of the app (written in Dart)
    connect/          // Contains repository* stuff (connect to student services, etc.)
    model/            // Contains plain old objects used all over the software (e. g. notice board entries, etc.)
    storage/          // Contains local SQLite database and connected storage classes for easy reading or writing model class instances
    ui/               // Contains all [Flutter](https://flutter.io/) UI specific things
        view/         // Contains all views to which you can navigate (Notice board, Login, ...)
        common/       // Contains commonly used Flutter widgets all over the software (*shared* **reusable** widgets)
    util/             // Contains shared utilities like common functional interfaces (Dart typedefs), ...
...

*: See here about repositories

Clone this wiki locally