Skip to content

Latest commit

 

History

History
207 lines (150 loc) · 8.76 KB

README.md

File metadata and controls

207 lines (150 loc) · 8.76 KB
Raw
Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

image

There're numerous web and mobile applications supporting students' life in JHU, yet functions of every application are too discrete so that students have to switch among various applications, which is inconvenient. For daily communication, course information, and academic resources, students would use a variety of apps at the same time, including Slack, Teams, Piazza, and SIS. Not to mention applications for school life like TransLoc, Hop-Rec, etc.

Moreover, it also paves a new way to improve upon the flaws in the existing applications used by JHU students, which are stated below:

Current JHU calendar application, Smesterly, does not have a mobile version, and details of courses, like where to submit assignments and when to take a midterm-exam, could not be added and showed in calendars. CampusGrpup is the only application where students can obtain information about campus events. However, it has a poor UI design and only allows students to view and register activities. Students won't be notified or even recommended if they don't voluntarily go to the page and check the activity list.

Built With

  • Swift
  • Cocoapods
  • Xcode
  • MongoDB / SQLite

(back to top)

Getting Started

Prerequisites

Navigate to local repo in terminal

  • cocoapods 
    pod install

Installation

  1. Clone the repo in Xcode 
    git clone https://github.com/jhu-oose-f22/team-gobluejays.git
  2. Install cocoapods packages 
    pod install

(back to top)

Usage

add.event.to.schedule.demo.mp4

For more examples, please refer to the Documentation

(back to top)

Database

Query the data in database

There are two ways to see data. The first is through query API like the example in AppDelegate.swift.

db.collection("events").getDocuments() { // handle the future object returned by getDocuments() }

Another is through portal. Open Firebase console, log in as the administrator ([email protected], password:gobluejays2022) and click the gobluejays project. From the left column you can find Firestore. There's database, collection and documents in it.

Attention

Before you push any data, be aware that you should create corresponding database and collection first. In k-v store, a collection can be modeled as a table in relational database, that means, every single module needs seperate collection to store.

Roadmap

  • Add to Schedule
    • implement frontend of the weekly calendar
    • add custom event to schedule
    • implement the backend for user events and activity
  • View campus events
    • implement frontend of the campus event tab
    • design UI interface of the event page on Figma
  • Access school apps and websites
    • Add more Apps and Websites to Apps/Websites Sections (Find icons online)
    • Create Apps and Websites Section on Home Page
    • Link About sections to appropriate websites, imitate UI from Academics for Athletics, Housing, Social Media sections
  • Setting page
    • set up team website
    • design user profile interface
    • implement user profile frontend

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Jessie Luo - [email protected]

Project Link: https://github.com/jhu-oose-f22/team-gobluejays

(back to top)

Acknowledgments

(back to top)