Git Product home page Git Product logo

bhstigers's Introduction

BHS Tigers README

By Chandra Suda

Bentonville High School Bentonville, AR

BHS Tigers is a mulitplatform application supporting IOS, Android, Web, MacOS, Windows, and Linux. When the application is opened for the first time, the user is given an option to single sign in or sign up. Single sign in can be acomplished through the registered account's email and password or through Google sign in. The Register page allows quick sign up into the app. They also have the option to rest their password. Once signed in there will be an first time onboarding leading to the home page. From the home page the user can view thier currrent schedule or access the settings through the account icon. They can also navigate to other pages with the bottom navigation bar or the widgets diaplyed in the home page. The Lunch page showcases the current lunch/breakfast menu with a calendar view other future/past menus. The floating action button, the Switch, allows quick navigation to switch from south building's lunch/breakfast menu to north building's, or vice versa. The Calendar page allows the user to view current school events, add/delete their own events, and toggle daily, monthly, and yearly calendars with school information. The Explore page allows the user to search through vast extracurriculars and academic oppurtinities. They can quick filte the clubs and sports wthrough the search bar, or access more information through the quick-access widgets. When a user clicks on the extracurricuar they will get more information and a quick option to email. The Connect page allows the user to view and interact with Bentonville High School's Twitter, Facebok, Instagram, and official website. They also can quickly send a email to Bentonvillle High School (BHS) staff and teachers. The Settings page allows a multitude of general options from dark mode, updating personall infromation, signing out, deleting their account, view the terms and privacy policy, send a bug report or feedback. BHS Tigers is currently bug free with the goal of making high school easier for students BHS.

FEATURES

  • Single Sign in with Google
  • Password Rest
  • Dynamic welcome message(greeting) with current date
  • Dynamic schedule based on current weekday
  • Schedule stored locally in shared prefernces - quick access
  • Advanced menu display with breakfast/lunch and north/south building toggle.
  • Enhanced calendar with user inputable events/monthly school events view/school year calendar
  • Vast collection of extracurricular resources with search to filter + in-app email to sponsors
  • Twitter, Facebook, Instagram, and School website integration + in-app email to teachers/staff
  • Advanced settings screen with dark mode, edit user info, privacy policy + terms & conditions, signout and delete account
  • Professional developer Bug reporting and Send feedback feauture.
  • Bottom sheet notification to enhance user experiance.

FOLDER LAYOUT

/CompiledApp

  • Signed APK for Android and Release Bundled for IOS

/Source

  • Fully Exported Flutter Code

/Documentation

  • Full explanation of the mobile app with screenshots and videos for thorough walkthrough.

BULD INSTRUCTIONS

This application is developed in Android Studio with the Flutter framework powered by the Dart programming language. Download and import to your IDE (Android Studio, Xcode, Visual Studio, etc.). Install the Flutter and Dart SDK. Choose your respective device (Web, Windows, MacOs, Linux, Android, IOS). Then "Run" or "Profile" the app by typing the command "Flutter run".

DOWNLOADING & RUNNING

  • MIN IOS 11.0
  • MIN Android SDK 21

SOFTWARE, PACKAGES, & SERVICES

References

LICENSE

MIT License

Copyright (c) 2022 Suda-C

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

bhstigers's People

Contributors

chandrasuda avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.