Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create folder in Resources for Documentation images #45

Merged
merged 35 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
1421c1e
Create folder in Resources for Documentation images
dhruvna1k Mar 14, 2024
bdf9309
Delete Prisma/Prisma.docc directory
dhruvna1k Mar 14, 2024
193c511
Create NotificationPermissions.png
dhruvna1k Mar 14, 2024
f012094
Delete Prisma/Supporting Files/PrismaApplication.docc/Resources/Onboa…
dhruvna1k Mar 14, 2024
d4c884e
Create NotificationPermissions.png
dhruvna1k Mar 14, 2024
f503aa4
Create NotificationPermission.png.license
dhruvna1k Mar 14, 2024
835a732
Create NotificationPermissions~dark.png
dhruvna1k Mar 14, 2024
b0f633f
Create NotificationPermissions~dark.png.license
dhruvna1k Mar 14, 2024
359c94c
Rename NotificationPermission.png.license to NotificationPermissions.…
dhruvna1k Mar 14, 2024
6ed3ef4
Add files via upload
dhruvna1k Mar 14, 2024
24114d3
Add files via upload
dhruvna1k Mar 14, 2024
7007c6c
Create AccountOnboarding.png.license
dhruvna1k Mar 14, 2024
50de410
Create AccountOnboarding.png.license
dhruvna1k Mar 14, 2024
3b35d99
Create AccountOnboarding~dark.png.license
dhruvna1k Mar 14, 2024
eb3b4fa
Create Chat.png.license
dhruvna1k Mar 14, 2024
5d52dc7
Create DataView.png.license
dhruvna1k Mar 14, 2024
f98207d
Create DataView~dark.png.license
dhruvna1k Mar 14, 2024
a78c98d
Create Scheduling.png.license
dhruvna1k Mar 14, 2024
7b55952
Create Scheduling~dark.png.license
dhruvna1k Mar 14, 2024
024c871
Update README.md
dhruvna1k Mar 14, 2024
bde3885
Rename AccounOnboarding.png to AccountOnboarding.png
dhruvna1k Mar 14, 2024
6e6bd10
Update README.md
dhruvna1k Mar 14, 2024
9ee47a4
Update AccountOnboarding.png.license
dhruvna1k Mar 14, 2024
ebd2714
Update AccountOnboarding~dark.png.license
dhruvna1k Mar 14, 2024
57f3df2
Update Chat.png.license
dhruvna1k Mar 14, 2024
91b8924
Update DataView.png.license
dhruvna1k Mar 14, 2024
6059727
Update DataView~dark.png.license
dhruvna1k Mar 14, 2024
ee866c2
Update NotificationPermissions.png.license
dhruvna1k Mar 14, 2024
7f88ad5
Update NotificationPermissions~dark.png.license
dhruvna1k Mar 14, 2024
6944bc1
Update Scheduling.png.license
dhruvna1k Mar 14, 2024
68b6b09
Update Scheduling~dark.png.license
dhruvna1k Mar 14, 2024
a9540f5
Update README.md
dhruvna1k Mar 14, 2024
6848a73
Update README.md for contributions
dhruvna1k Mar 14, 2024
2c1701c
Update README.md contributions spruce
dhruvna1k Mar 14, 2024
57b0435
Merge branch 'main' into dhruv-documentation-writing
dhruvna1k Mar 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Prisma/AccountOnboarding.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright (c) 2023 Stanford University

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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This source file is part of the Prisma Application open-source project

SPDX-FileCopyrightText: 2024 Stanford University

SPDX-License-Identifier: MIT
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,28 @@ The CS342 2024 PRISMA application is using the [Spezi](https://github.com/Stanfo

> [!NOTE]
> Do you want to try out the CS342 2024 PRISMA application? You can download it to your iOS device using [TestFlight](https://testflight.apple.com/join/bPu7kUoM)!
>
The CS342 2024 Prisma app as of March 14, 2023 includes added functionality for push notifications, controlling personal data usage via privacy controls, and authenticated chat interface dialogue.


## CS342 2024 PRISMA Features
The following are screenshots showing various aspects of the Prisma application.

*Provide a comprehensive description of your application, including figures showing the application. You can learn more on how to structure a README in the [Stanford Spezi Documentation Guide](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/documentation-guide)*

> [!NOTE]
> Do you want to learn more about the Stanford Spezi Template Application and how to use, extend, and modify this application? Check out the [Stanford Spezi Template Application documentation](https://stanfordspezi.github.io/SpeziTemplateApplication)
| Account Onboarding | Notification Permissions | Data View |
|:------------------:|:------------------------:|:---------:|
| ![An account Onboarding page.](Prisma/Supporting%20Files/PrismaApplication.docc/Resources/Onboarding/AccountOnboarding.png#gh-light-mode-only) ![An account Onboarding page.](Prisma/Supporting%20Files/PrismaApplication.docc/Resources/Onboarding/AccountOnboarding~dark.png#gh-dark-mode-only) | ![A Notification Permissions page.](Prisma/Supporting%20Files/PrismaApplication.docc/Resources/Onboarding/NotificationPermissions.png#gh-light-mode-only) ![A Notification Permissions page.](Prisma/Supporting%20Files/PrismaApplication.docc/Resources/Onboarding/NotificationPermissions~dark.png#gh-dark-mode-only) | ![A data view.](Prisma/Supporting%20Files/PrismaApplication.docc/Resources/Onboarding/DataView.png#gh-light-mode-only) ![A data view.](Prisma/Supporting%20Files/PrismaApplication.docc/Resources/Onboarding/DataView~dark.png#gh-dark-mode-only) |


## Contributing

*Ensure that you add an adequate contribution section to this README.*
| Name | Contribution |
|------------|--------------|
| **Caroline** | Implemented the UI, publisher, fetching, and modifying features for Firestore data given the user’s selection on data upload and redaction of data for the privacy controls. |
| **Dhruv** | Wrote centralized privacy module class for management and storage of selected data. Worked collaboratively with Evelyn S. to create an end to end pipeline of chat interface authentication. |
| **Evelyn H.** | Implemented the UI for privacy controls, fetching and updating data in Firestore to reflect user changes in hiding data by timestamp or time range. |
| **Evelyn S.** | Worked collaboratively with Dhruv to create an end to end pipeline of chat interface authentication. The iOS app sends a JWT to the frontend, which then verifies the JWT using Firebase Admin SDK in the backend, and the user can then access the chat view
| **Bryant** | Implemented client side handling for push notification registration + handling, as well as the backend listener system and scheduling for notifications/schedule changes. Also added testing framework to backend. |



## License
Expand Down
Loading