Code Monkey home page Code Monkey logo

sst-announcer-ios's Introduction

SST Announcer (iOS)

Language Xcode Cocoapods

iOS iPadOS Mac Catalyst

SST Announcer was built to help SST Students stay up to date with the school’s announcements with ease and convenience on their devices. The app allows users to browse, pin and share important announcements made by the school. The app also sends notifications to students whenever a new announcement is posted. This helped to ensure that students are kept updated with the latest information from the school.

Original design by FourierIndustries (formerly StatiX Industries)

Revamped in 2018 by OrbitIndustries

Revamped, again, in 2020 by Jia Chen and Shannen


Installation

This project uses Cocoapods. Check the Podfile for more information.

  1. To install Cocoapods, in terminal, run sudo gem install cocoapods
  2. To install the pods into the project, go to the project's directory and run pod install on this project
  3. Open the Announcer.xcworkspace
  4. Done

or just download on the App Store

App Store

Requirements

  • Xcode 11.4 or greater
  • Swift 5
  • iOS 13 or greater
  • iPadOS 13 or greater
  • MacOS 10.15 or greater
  • Cocoapods 1.8.4 or greater

Technologies/Libraries Used

Open Source Libraries

  • URLEmbeddedView
    • Previewing Links in the blog posts
    • Installed using Cocoapods
  • FeedKit
    • Fetching data from Students' Blog (Atom feed)
  • KALoader
    • Loading animations while getting data from RSS feed

Apple Technologies

  • UIKit
    • User Interface for iOS, iPadOS and MacOS
  • Mac Catalyst
    • To enable MacOS support
  • Background Tasks
    • Fetching new blog posts in the background, on device.
    • This is easier and more cost effective than running a server to push notifications to each device
      • TL;DR: I'm broke so this is the best way
      • Limitations:
        • Unable to work with Low-Power Mode on
  • User Notifications
    • To send notifications to the users whenever a new post comes (works together with Background Tasks)
  • Core Spotlight
    • To allow users to search for announcements using spotlight search

Screenshots (iOS)

Dark and Light mode

Home

Content

Search with Tags

Spotlight Search

Colors

Main Colors

These colors are used for different parts of the app such as backgrounds and labels.

Color Name Identifier Light Theme Dark Theme
Background "background" - #F5F4F6 - #060400
Global Tint "Global Tint" - #A9A9A9 - #A9A9A9
Grey 1 "Grey 1" - #434343 - #B8BABB
Grey 2 "Grey 2" - #DCDADB - #252628

Apple Colors

These colors are the ones as part of Apple's UIColor Human Interface Guidelines

Color Name API Light Theme Dark Theme
Blue .systemBlue - #007BFF - #0A84FF
Label .label - #000000 - #FFFFFF

Loading Colors

These colors are used for loading content using KALoader

Color Name Identifier Light Theme Dark Theme
First Load Color "First Load Color" - #DEDEDE - #202020
Second Load Color "Second Load Color" - #DDDDDD - #212121
Back Gray Color "Back Gray Color" - #F6F6F6 - #080808

sst-announcer-ios's People

Contributors

jiachenyee avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

sst-announcer-ios's Issues

App could not be opened on download. [BUG]

General Information

Device

  • Device: 2017 Macbook Pro
  • OS: MacOS 11

App

  • App Version: 11.2
  • App Build: 2.2

Bug Information

Description

When downloading the app, it does not open, and promps an error.
Screenshot 2020-08-11 at 7 18 16 AM

How to Reproduce

Download the app from the link given

Steps to reproduce this issue:

  1. Open the Google Drive link
  2. Download it
  3. Open it

Expected behaviour

The app is supposed to open

Screenshots

Screenshot 2020-08-11 at 7 18 16 AM

Additional context

nil

App Won’t Open; Keeps Crashing (Beta)

General Informaiton

Device

  • Device: iPhone X
  • OS: iOS 13.4.1

App

  • App Version: 11.2
  • App Build: 2.2

Bug Information

Description

App beta just installed, crashes on opening

How to Reproduce

Steps to reproduce this issue:

  • Install beta from TestFlight
  • Open App
  • Watch the App crash
  • Jia Chen asked me to file report on GitHub so here I am

Expected behaviour

The app should launch and open

Screenshots

The app does not even open

Additional context

Nope.

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.