GithubHelp home page GithubHelp logo

šŸ‘‹ FBLA UpToDate

šŸ¤“ READ ME FILE.md overview

The goal of this document is to give you a specific guideline to our developed app -UpToDate. Please have a look at all the attached documents and descriptions below. Thankyou for your cooperation.

Introduction: Team

Hi, Iā€™m @WinniePon (Student 1) Iā€™m currently a student studying in Shanghai High School International Division. I have a huge passion in mobile application design and development. Iā€™m currently participating in the FBLA National Leadership Conference taking place in June at Atlanta Georgia.

Hi, Iā€™m @Frank (Student 2) Iā€™m currently a student studying in Shanghai High School International Division. I have a huge passion in mobile application design and development. Iā€™m currently participating in the FBLA National Leadership Conference taking place in June at Atlanta Georgia.

Our team is currently designing a mobile application named UpToDate. UpToDate in essence, is a calendar app designed for schools to help parents as well as students themselves to be aware of upcoming school events, assignment deadlines, and holidays. The app provides a calendar, schedule, photo sharing function, absence reporting function, AI chat assistant, and bug reporting system.

:octocat: Overview UpToDate

UpToDate is a mobile application for Android devices. To log into the app, users must enter their email and password. Once in the app, users can view upcoming upcoming school events, assignment deadlines, and holidays in the calendar and Upcoming Events Bar. The Menu Bar contains Community, AI Counsellor, Absence Request, Schedule, Contact Us, and Log Out. FBLA UpToDate is currently error free, and the team also implemented a bug reporting system for users to notify our team on bugs.

Features

Features:

  1. Designed by Android Studio

  2. Options to login with email and password. If user does not have an account, register an account

  3. AI Counsellor provides AI generated responses about college related questions

  4. Calendar, Upcoming Events bar that marks upcoming events

  5. Schedule to show studentā€™s courses and timetable

  6. Absence Request to file student absences

  7. Profile icon to edit personal information as well as profile picture

  8. Contact Us contains our teamā€™s contact information on Twitter and WeChat and bug reporting system

  9. Community allows students to post pictures and text about school events

  10. Enhance notifications when a new post is created

Folder Layout

/Compiled APP

contains our compiled, signed app from the Android Platform

/Documentation

contains pdf overview of the app along with screenshots and explanations of the app's functionality

/Source

Contains visual studio 2023 coding source file

/Scrum System

Provides a visual and descriptions of the scrum system planning and organization

How To Run

This app was developed...

Committing and pushing are how you can add the changes you made on your local machine to the remote repository in GitHub. That way your instructor and/or teammates can see your latest work when youā€™re ready to share it. You can make a commit when you have made changes to your project that you want to ā€œcheckpoint.ā€ You can also add a helpful commit message to remind yourself or your teammates what work you did (e.g. ā€œAdded a README with information about our projectā€).

Once you have a commit or multiple commits that youā€™re ready to add to your repository, you can use the push command to add those changes to your remote repository. Committing and pushing may feel new at first, but we promise youā€™ll get used to it šŸ™‚

šŸ’» Build Instructions

Source Code

.....

Resources Used

Mobile app design logo/brand (canvas) https://www.canva.com/zh_cn/

Mobile app animations (i-movie) (app)

National official photos from FBLA-PBL https://www.fbla.pbl.org/fbla/officers/

Softare and Services Used

  1. Github https://github.com/

Github is an online sourcing hosting service based around the Git version controlling system. The team utilized Github to store source coding revisions throughout this project

  1. HOOT https://dash.readme.com/project/uptodate-mobile-application/v1.0/overview

HOOT provides a specific guidline in how to access/create a Read Me File

  1. Zenhub https://zenhub.com/

Zenhub was used to create the system's major backlogs and scrum system tracker. It helps to set goals and ensure certain deadline notifications for the team.

  1. InstaBug -https://zenhub.com/

Instabug is a Software Development Kit (SDK) that empowers mobile-first companies to iterate faster and enhance their app quality by providing intuitive user feedback channels and comprehensive bug and crash insights.

  1. https://www.monday.com

Monday dev is a product that supports scrum methodology, with an option to work in Kanban style. The work OS promotes transparency, adaptability and speed up product development process, without impacting quality. With flexible scrum software, the team can easily get more done in shorter feedback

The Team's mission

Our mission at UpToDate is to help students and parents keep track of important events, academic progress, and improve student time management skills. Our three key values are time management, punctuality, and academic growth. UpToDate aims to expand its use to the entire student body at SHSID and also adapt to teachersā€™ usage.

The Team's Brand/Logo

Our brand name UpToDate reflects our mission statement and values and is also closely related with our logo. The calendar embodies punctuality; the squares that pop up are notifications on upcoming events. The checkmark represents time management and completion of tasks acting as a predominant affirmative symbol of convenience and awareness.

Your user profile

Your profile page tells people the story of your work through the repositories you're interested in, the contributions you've made, and the conversations you've had. You can also give the world a unique view into who you are with your profile README. You can use your profile to let future employers know all about you! To learn more about your user profile and adding and updating your profile README, read "Managing Your Profile README".

Using markdown on GitHub

You might have noticed already, but you can add some fun styling to your issues, pull requests, and files. "Markdown" is an easy way to style your issues, pull requests, and files with some simple syntax. This can be helpful to organize your information and make it easier for others to read. You can also drop in gifs and images to help convey your point! To learn more about using GitHubā€™s flavor of markdown, read "Basic Writing and Formatting Syntax".

How To Access/Contributes: (detailed)

The GitHub community is vast. There are many types of people who use GitHub in their day to dayā€”students like you, professional developers, hobbyists working on open source projects, and explorers who are just jumping into the world of software development on their own. There are many ways you can interact with the larger GitHub community, but here are three places where you can start.

Login Page

  1. The login page is basic. First time users may use the Sign Up option to register their own UpToDate account by entering their student ID, or in our case, GNumber, and setting up a private password. Users who already have an established account need only to enter their student ID and password to Sign In. By using Selenium from Python, the student GNumber input is entered into our schoolā€™s website, automatically logging in and extracting the studentā€™s personal timetable which is then put on the Schedule page of our app. After users successfully Sign In to their accounts, users can customize their personal information by accessing the profile icon located at the top right corner. Users can select pictures from their photo gallery as new profile pictures.

Home Page

  1. The Home Page includes a calendar, the Upcoming Events bar, as well as the Menu Bar. The Calendar includes the date, month, and year. The Upcoming Events bar chronologically organizes upcoming events, assignment deadlines, holidays, and exams. The Menu Bar, located on the top left corner, displays 7 main options each of whichā€™s functions weā€™ll explain in-depth.

Schedule

  1. The Schedule contains the weekly timetable for each student. Students or parents can check their upcoming classes, teachers, and locations. The timetable is organized into two columns: the course names and corresponding time periods.

Community (social media)

  1. Community is UpToDateā€™s social media platform where users may post logs or pictures about school events. The Write Post option will bring users to a separate page, where users may customize their own drafts to post. Users can view each otherā€™s posts and scroll to refresh and see more posts.

Absence Request

  1. Absence Request allows parents or students themselves to file leaves when students cannot attend school. First, users would select the specific date they would be absent with the Calendar. If the student would be absent for consecutive days, multiple Requests would have to be filed. In the text box, users need to enter the reason for their absence.

AI Counsellor

  1. AI Counsellor is an AI chat assistant dedicated to providing research on colleges for high school students. Users have to enter the name of a university plus the term univeristy/college/school theyā€™re interested in and come up with a question they have about that school. The Counsellor would then generate a response to the question. The refresh button will return users to the initial page. With Counsellor, which also needs to contain the phrasing of the school plus university/college/school.

Contact US Page

  1. The Contact Us page contains two functions. The first is a bug reporting system that allows users to report errors via text or screenshots. The reports would be forwarded to our teamā€™s emails, where we will ensure the changes are fixed asap. The latter half of the page contains our teamā€™s contact information on WeChat and Twitter.

API References

App Installation

Simply download form the app store using phone/tablet

References/Credit

  1. FBLA-PBL

www.fbla.pbl.org

  1. FBLA Competitive Events Academics Competitions for High School Students

https://www.fbla-pbl.org/fbla/competitive-events/

  1. Eastern PA,FBLA Study Set

https://quizlet.com/354843028/pa-fbla-state-officer-exam-flash-cards/

  1. Competitive Events Program - PA FBLA

https://www.pafbla.org/programs/competitive-events-program/

  1. Ryan Zhang (student in Shanghai High School- freshman that helps with the coding of this project)

License

MIT License

Copyright (c) 2023 Eddie Jaoude

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.

šŸ“ Code of Conduct

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected] & [email protected]

All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

šŸ“š Resources

winniepon's Projects

copyrightlicense icon copyrightlicense

MIT License Copyright (c) 2020 The AI Guy 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

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.