Kooperlol / milton_relay

A project for FBLA Mobile App Development (2022-23)

Milton Relay

A project for FBLA Mobile App Development (2022 - 2023)

❓ About The Project

Milton Relay is a mobile application for my school to help keep parents and the community up to date. The app includes upcoming events, important information such as the school calendar and activities schedule, a way for teachers and students to share photos, and a way for parents to notify the school of student absences. In addition, I added a Laude Point calculator recommended by the school administration. In the program, there is a admin, student, teacher, and parent interface, each with different features.

🏆 Program Awards

#1 Wisconsin - State
#4 Georgia - Nationals

📜 Requirements Met

The program meets the requirements stated on the FBLA Application Development Rubric

• Packaged with complete file, readme, and instructions.
  • The readme contains instructions and relevant information. The program is packaged so that it can easily be cloned and ran on another machine.
• Application functionality.
  • The application is compatible with both IOS and Android. In addition, it can be resized to display on phones and tablets.
• Documentation and copyright compliance.
  • The application is licensed under MIT and all resources used are cited below and copyright free.
• Application addresses the topic.
  • The application addresses the topic fully by including a news feed, photo sharing, student absences, a calendar, and a feature recommend by my school administration.
• Planning process.
  • Tangible documents will be provided to show the planning process. This includes some flowcharts, google documents, and Figma blueprints.
• Navigation.
  • The app navigation is simplistic and easy to use with there being a bottom navigation bar and header containing intuitive UI.
• Code.
  • The code contains comments and all code is error free during compilation. If runtime errors occur, they can be reported through the bug report system.
• Icons and Graphics.
  • The Milton Relay logo is integrated into the app's header, which is persistent throughout the app's UI. In addition, it relates to the app as it has our school mascot within a chat box, which shows that it is a communication app for our school.
• Social media.
  • The school's facebook is linked on the news page so students can easily access school district feed. On the media sharing tab, there is an option to share your post directly with Instagram or Twitter.
• Bugs.
  • The application does not have any known bugs. However, if a bug is stumbled upon, a user can easily report the bug through the app's bug report system.

👷 Built With

Technology	Description
	A framework that can compile to multiple operating systems from just one coding language.
	A backend database used for authentication, file storage, and document storage.

💾 Dependencies

• Table Calendar
• Image Picker
• Flutter Spinkit
• Responsive Sizer
• GetWidget
• Social Share
• Add 2 Calendar
• dotenv
• Checkbox Grouped
• Intl
• Loader Overlay
• Multiselect
• UUID
• Webview Flutter
• GoRouter
• Flutter SVG
• Dots Indicator
• Readmore
• URL Launcher
• Path
• HTTP
• Path Provider

🔌 External Resources

• Undraw
• TagBox
• Pexels
• UX Wing
• OpenSans
• Best Readme Template
• Github Image Shields

📱 Compatibility

🔧 Getting Started

To get a local copy up and running follow these simple steps.

🧠 Prerequisites

Install the following before cloning the project.

• Flutter
• An Emulator

⬇️ Installation

Clone the repository and compile the code in an IDE such as Android Studio, XCode, or Visual Studio Code.

• Go to Firebase and create an account. After that, create a project that supports IOS and/or Android and follow the given steps.
• Add the following modules to the project: Authentication, Firestore, and Storage.
• In Authentication, create an admin account with the email "[e-mail]" and make a secure password.
• In Firestore Database, create a users, posts, absences, issues, and events collection.
• In Storage, create an avatars, events, issues, and posts folder.
• Then, launch the application and sign in as an administrator.
• Navigate to the users tab and at the top click the add user button. From there, add all of the students, teachers, and parents to the application.

📑 Instructions

https://github.com/Kooperlol/milton_relay/blob/master/documentation/instructions.pdf

📓 Planning Process

https://github.com/Kooperlol/milton_relay/blob/master/documentation/planning-process.pdf

👨‍⚖️ License

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

✉️ Contact

Kooper Propp - [e-mail]
Project Link: https://github.com/Kooperlol/milton_relay