Appetizer

Appetizer is a cross platform appication built in flutter to digitalize IIT Roorkee Mess.

Getting Started

Follow these instructions to build and run the project

Setup Flutter

A detailed guide for multiple platforms setup could be find here

Cloning From GitHub

To clone the repository, either use the Git GUI if you have one installed or enter the following commands:

git clone https://github.com/mdg-iitr/Appetizer-flutter.git
cd Appetizer-flutter

Note: If you want to contribute, first fork the original repository and clone your forked repository into your local machine. If you don't do this, you will not be able to make commits or change any files.

git clone https://github.com/<username>/Appetizer-flutter.git
cd Appetizer-flutter

Next Steps

• flutter pub get to get all the dependencies.
• flutter run

This project uses flutter version 2.0.4 and hence the support for compile time variables. To use compile time variables pass them in --dart-defines as flutter run --dart-define=VAR_NAME=VAR_VALUE. Supported dart-defines include :

Google Services Configuration

1. Create a firebase project.
2. Add Android & iOS app with the package_name and bundle_identifier respectively as in.ac.iitr.mdg.appetizer.
3. Download google-services.json from firebase and place in android/app/.

Sentry Configuration

Appetizer uses Sentry to track errors and performance monitoring.

1. Create a sentry.io project to get hold of SENTRY_DSN.
2. SENTRY_DSN can be configured to use with --dart-defines. Details of the dart-defines are as mentioned above. SENTRY_DSN

Note: The Google Services Configuration section is mandatory to get started but the Sentry Configuration part is optional.

Project Structure

Appetizer-flutter/lib/
├── config/                         # configuration files like environment_config
├── enums/                          # enum files
|   └── view_state.dart             # defines view states i.e Idle, Busy, Error
├── models/                         # model classes
|   └── dialog_models.dart          # dialog request and response models
        ...
├── services/                       # services
|   ├── API/                        # API implementations
|   └── dialog_service.dart         # handles dialog
|   └── local_storage_service.dart  # handles local storage (shared prefs)
├── ui/                             # UI layer
|  ├── views/                       # views
|  |  └── base_view.dart
|  |  └── home_view.dart
|  |  └── startup_view.dart
|  └── components/                  # shared components
├── utils/                          # utilities such as api_utils, app_exceptions.
├── viewmodels/                     # Viewmodels layer
├── app_theme.dart                  # Shared App Colors/Styles etc.
├── constants.dart                  # App constants
├── locator.dart                    # dependency injection using get_it
├── main.dart                       # <3 of the app

Screenshots

Community

We would love to hear from you! We communicate on the following platforms:

How to Contribute

Whether you have some feature requests/ideas, code improvements, refactoring, performance improvements, help is always Welcome. There are just a few small guidelines you need to follow.

• When contributing to this repository, please first discuss the change you wish to make via the issues section before starting any major work.
• Ask for this issue to be assigned to you by any of the maintainers before getting started (given that the issue hasn't already been assigned to someone else). If the issue has not been active for more than 10 days, a reassign can be requested.
• Once you have started work on any issue open a WIP pull request addressing that issue so that we know that someone is working on it.
• While writing any code for this project ensure that it is well formated and consistent with the architecture of the rest of the project.
• Please make sure that you use the standard dart nomeclature.
• Appetizer uses pedantic for linting purposes. So, make sure the linting warnings are taken care of before commiting or creating a PR.

If you found any bugs, consider opening an issue.

For commit messages

Please start your commits with these prefixes for better understanding among collaborators, based on the type of commit:

feat: (addition of a new feature)
rfac: (refactoring the code: optimization/ different logic of existing code - output doesn't change, just the way of execution changes)
docs: (documenting the code, be it readme, or extra comments)
bfix: (bug fixing)
chor: (chore - beautifying code, indents, spaces, camelcasing, changing variable names to have an appropriate meaning)
ptch: (patches - small changes in code, mainly UI, for example color of a button, incrasing size of tet, etc etc)
conf: (configurational settings - changing directory structure, updating gitignore, add libraries, changing manifest etc)