monday-morning/project-pegasus

The repository for the Mobile Application of Monday Morning, the official student media body of NIT Rourkela.

Monday Morning

The Official Student Media Body of NIT Rourkela

View Live • View Issues • Report Bugs • Suggest Features

Project Overview

Table of Contents

1. About Monday Morning
2. About the Project
3. Built With
4. Getting Started
   • Contribution guidlines
   • Local Repository Setup
   • Running the project
5. License

About Monday Morning

Monday Morning is the student media body of National Institute of Technology, Rourkela. Since its inception in 2006, it has constantly served as a vital link between the student community and the administration. The weekly e-newsletter serves as a news feed for the students, professors and alumni of the institute, featuring campus activities, department updates, recruitment information, SAC happenings, alumni news, weekly polls and interviews of the Director, Chief Warden, professors, distinguished alumni and dignitaries and exceptional students. Apart from the online weekly edition, Monday Morning also publishes print editions and organises the Open House Discussion.

About the Project

Project Infinity is about updating the Monday Morning website using modern technologies which is divided accross 3 main sub-projects.

1. project-tahiti: The Client side application of the website.
2. project-reclamation: The Server application of the website.
3. project-pegasus: The cross-platform Mobile application of the Monday Morning.

Built With

Following technologies and libraries are used for the development of this website

• Dart
• Flutter
• Riverpod
• Firebase
• GraphQL
• graphql_flutter

Getting Started

To setup the project locally follow the steps below.

Contribution guidlines 🎃

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

Local Repository Setup

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your local system
3. Commit changes to your own separate branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

Running the project.

1. Install Flutter on your machine

   Install flutter by selecting the operating system on which you are installing Flutter: Flutter installation tutorial

   To check if you have flutter installed along wtih proper necesarry SDKs installed run flutter doctor

2. Fork and Clone the Repo

   Fork the repo by clicking on the Fork button on the top right corner of the page. To clone this repository, run git clone https://github.com/Monday-Morning/project-pegasus.git Then run cd app

3. Get Packages

   Make sure you are in the project-pegasus/app directory

   • From the terminal: Run flutter pub get. OR
   • From Android Studio/IntelliJ: Click Packages get in the action ribbon at the top of pubspec.yaml.
   • From VS Code: Click Get Packages located in right side of the action ribbon at the top of pubspec.yaml.

4. Configure

   Make sure you are in the project-pegasus/app directory

   • Activate FlutterFire by running dart pub global activate flutterfire_cli.
   • Configure the project by running dart pub global run flutterfire_cli:flutterfire configure.
   • You can use firebase emulator to run the project.

5. Build

   To build the project run flutter pub run build_runner build.

Run the App

On terminal:

• Check that an Android device is running by running flutter devices. If none are shown, follow the device-specific instructions on the Install page for your OS.
• Run the app with the following command: flutter run .

License

Distributed under the MIT License. See License for more information.

project-pegasus's Issues

feat: squiggles

Setup Local Database using Hive

Using Test-Driven Development, setup local database for storing local app data using Hive Db.

Setup Size Config for the project

Setup Size Config for developing adaptive layouts

Riverpod Refactor

feat: article card and stack

• feat: single card element
• feat: iterable stack

feat: home screen

• #29
• feat: logo and search bar (#23)
• feat: hero element
• #25
• feat: upcoming event and ongoing poll (#27)

feat: categories page

• #27
• #26

feat: authentication userflow

• feat: sign in
• feat: sign up and onboarding screens
• feat: user profile

feat(ci/cd): setup github actions

Possible CI/CD Workflows:

• feat(ci/cd): Dart Formatter
• feat(ci/cd): Dart Linter
• feat(ci/cd): Flutter Unit Tests
• feat(ci/cd): Firebase Test Lab
• feat(ci/cd): APK Builds
• feat(ci/cd): iOS Builds
• feat(ci/cd): Google Play Release
• feat(ci/cd): App Store Release

Setup linting for the project

Context:

In order to have a healthier code base and avoid errors, configuring extra lint rules based on our requirements would be helpful.

Requirements:

Extend the linting support to the project by setting required linting rules.

Proposed Solution:

Configure the required rules in analysis_options.yaml using the lint package.

Setup Localization

Context:

For solving the problem of using many string literals inside the app, we have to setup localization for the app.

Requirements:

We will have a single file for defining the string literals in the form of key-value pair whose value we can access anywhere in the app and use it.

Proposed Solutions:

We can use the package easy_localization to solve it.

Setup auto_route for navigation

Context:

Setup auto_route for the project.

Requirements:

We can use auto_route package for making the navigation service of the app easier.

Proposed Solution:

Using auto_route_generator along with auto_route we can generate code for the navigation sevices.

feat: category cards

• feat: small cards
• feat: large cards

feat: play store app update popup on app launch

Purpose

• Request the user to update the app when possible
• (Optional) Enforce a minimum usable version to allow for future breaking changes without backwards compatibility

Additional context

Setup Dependency Injection

Context

Configure Dependency Injection for project-pegasus.

Requirements

Instead of manually writing the code for injecting dependencies, use a package to generate code for it.

Proposed solutions

Use injectable along with get_it for code generation.

fix: app Logo

feat: animations

• feat: splash screen
• feat: loading screen

Upgrade minSdkVersion, targetSdkVersion and compileSdkVersion

Change minSdkVersion to 21, since Firebase plugins throw a lot of errors with minSdkVersion 16.
Change compileSdkVersion and targetSdkVersion 30, to keep up with latest sdk additions and changes to the latest device APIs on Android.

Svg icons in categories page looks pixelated

• exporting it correctly will fix this issue
• those icons are png images; hence they look pixelated
• will update with SVG icons

wip: optimize image loading

Tasks:

• Implement blurhash to display dummy images
• Download low quality image variants from imagekit for thumbnails
• Implement cached network image to prevent same image being downloaded multiple times

feat: bottom bar

wip: dark mode switch with state management

Tasks:

• Create a switch for dark mode in the more page
• Modify app config to allow for updates and to notify
• Store user's mode choice in shared_preferences

wip: error handling for network conditions

Tasks:

• Create a custom error screen for when the user is not connected to the internet.
• Add a check in app initialization and show error screen if required
• Watch for change in network status and show error screen when required

Additional Context

• https://pub.dev/packages/connectivity_plus
• https://stackoverflow.com/questions/49648022/check-whether-there-is-an-internet-connection-available-on-flutter-app

Consider using package versions in pubspec.yaml and check in pubspec.lock into repository

• Without specifying versions in pubspec.yaml versions won't be locked. Package might get upgraded to next major version or to a version with some bug automatically causing unwanted errors during development
• Having a pubspec.lock in the repo is necessary when you are collaborating with others. So that the exact dependencies are installed reproducibly whenever any developer runs flutter pub get

Setup Theme Manager And Themes

Context:

Setup Theme manager for managing themes.

Requirements:

Use a theme manager to configure and manage multiple themes.

Proposed solution:

stacked_themes package can be used for this purpose.

feat: migrate auto_route to v6+

Migration Guide

feat: search

• feat: search bar
• #25