Skip to content

Code-For-Community-Organization/SMHS-School-App

Repository files navigation

SMHS Schedule: A SwiftUI app for viewing the SMHS schedule

SMHS Schedule is the one-stop experience for Santa Margarita Catholic High School's students, much better than the official SMHS app. Made by a SMHS student, for SMHS students, SMHS Schedule aims to deliver a beautiful and native app experience. If you like this project, please star ★.

DOWNLOAD NOW on the App Store 👇

The backend serverside code for this app -> https://github.com/jevonmao/SMHS-Schedule-Backend

SMHS Schedule looks equally gorgeous on your iPhone and iPad.

🧭 Navigation

✅ Tasklist

🔨 Build

This repo is an Xcode Project that contains the SMHS Schedule cross platform app for iOS and macOS. To get things running:

Prerequisite

  1. A Mac running macOS Catalina 10.15.4 or later
  2. Xcode 12.1 or later

Steps

  1. Clone or fork the repo
https://github.com/jevonmao/SMHS-Schedule.git
  1. Open the SMHSSchedule.xcodeproj file to load project
  2. On the upper left corner, select approriate scheme for iOS or macOS
  3. Swift Package Manager should automatically install all dependencies, and you can now build or run the app!
  4. Note: Select SMHSSchedule(iOS) Release for release build, or SMHSSchedule(iOS) Debug for debug build. Ignore other schemes. To learn more about SPM, click here

✨ Features

InClass™ Countdown

The InClass™ countdown features a live countdown and a progress ring that displays time left for the current period. Easily visualize the time left in class and get on top of your schedule.


SMHS Schedule, Effortlessly.

The Schedule tab makes it effortlessly easy to view all your class schedules. For all future dates. Browse through all the schedule dates in a beautiful list, and tap on any date to glance the detailed schedule for that day.


School News, Stay Updated.

Stay updated on the newest campus news stories, all on your fingertips. SMHS Schedule provides a supercharged in-app school news reading experience, with gorgeous photos and graphics, and iOS native reader view.


Made by SMHS Student, For SMHS Students.

This is a project of Jevon Mao, a class of 2024 student at SMHS. SMHS Schedule is built ground-up from a students' perspective, and will undergo constant update bringing new features.


❓ Why

Mission Statement

The SMHS app project's mission is to inspire the next generation of student coders and dreamers. SMHS app leads the way as a student created app by providing an enhanced experience to thousands of Santa Margarita Catholic High School students, teachers, and parents.

About the app

My original motivation was that me as a SMCHS student needed to see the class schedule several times a day. With the official SMHS app as my only option, I quickly noticed issues and nuances where the app left plenty of room for improvements. With my skills of Swift and iOS development, I decided to make a better app from scratch.

For the 1600 students attending SMHS, this app will greatly enhance students' school experience by providing a one-stop app that offers a variety of features.

When compared to the official SMHS app, SMHS Schedule is designed and built to specifically tackle areas that the official app lacked. For example, the official app had the problem of slow loading. Viewing the schedule would required multiple taps to reveal deeply nested navigation menu, and each menu took several seconds of loading. This resulted in a problematic user experience. In my SMHS app, all the schedule information is cached locally to device. Users can easily view schedule that instantly load and is easily accessible on the home screen.

💪 Contribute

Contributions are welcome here for coders and non-coders alike. No matter what your skill level is, you can for certain contribute to SMHS Schedule's open source community.

Please read contributing.md before starting. Check the issues or the README feature tasklist for things to work on.

If you encounter ANY issue, have ANY concerns, or ANY comments, please do NOT hesitate to let me know. Open a discussion, issue, or email me. As a developer, I feel you when you don't understand something in the codebase. I try to comment and document as best as I can, but if you happen to encounter any issues, I will be happy to assist in any way I can.

⚖️ License

SMHS Schedule is created by Jingwen (Jevon) Mao and licensed under the MIT License


JUMP TO TOP