misc: add readme and legal docs

PRIVACY.md

@@ -0,0 +1,37 @@
+# GoKnights Privacy Policy
+
+This privacy policy ("policy") will help you understand how Ming Lei ("us", "we", "our") uses and protects 
+the data you provide to us when you visit and use GoKnights ("app", "service").
+
+We reserve the right to change this policy at any given time, of which you will be promptly
+updated. If you want to make sure that you are up to date with the latest changes, we advise
+you to frequently visit this page.
+
+## What User Data We Collect
+
+When you use the app, we may collect the following data:
+
+- No data is collected by the app.
+
+## Why We Collect Your Data
+
+We are collecting your data for several reasons:
+
+- Not applicable, because no data is collected.
+
+## Safeguarding and Securing the Data
+
+The app is committed to securing your data and keeping it confidential. The app has done all in its
+power to prevent data theft, unauthorized access, and disclosure by implementing the latest
+technologies and software, which help us safeguard all the information we collect online.
+
+## Our Cookie Policy
+
+The app do not use cookies or similar technologies to collect data about the user.
+
+## Links to Other Websites
+
+Our app contains links that lead to other websites. If you click on these links, the app is not
+held responsible for your data and privacy protection. Visiting those websites is not governed by
+this privacy policy agreement. Make sure to read the privacy policy documentation of the
+website you go to from our app.

README.md

@@ -1,12 +1,99 @@
-# goknights
+<a name="readme-top"></a>
+[![wakatime](https://wakatime.com/badge/github/popoway/goknights.svg)](https://wakatime.com/badge/github/popoway/goknights) 
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/popoway/goknights)
+![GitHub language count](https://img.shields.io/github/languages/count/popoway/goknights)
+![GitHub last commit (branch)](https://img.shields.io/github/last-commit/popoway/goknights/main)
 
-A new Flutter project.
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/popoway/goknights">
+    <img src="assets/icon/icon.png" alt="GoKnights logo" width="80" height="80">
+  </a>
+
+  <h3 align="center">GoKnights</h3>
+
+  <p align="center">
+    Your Queens College Knights experience, elevated
+    <br />
+    <a href="#readme-toc"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/popoway/goknights">View Demo</a>
+    ·
+    <a href="https://github.com/popoway/goknights/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/popoway/goknights/issues">Request Feature</a>
+  </p>
+</div>
+
+## Table of Contents
+<a name="readme-toc"></a>
+- [Description](#description)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+- [Contributing](#contributing)
+- [Privacy](#privacy)
+- [License](#license)
+
+## Description
+
+Inspired by numerous inquiries and questions from incoming freshmen during new student orientation this summer, this app is created in order to serve as a centralized destination to showcase some of the highlighted student services and resources available on campus.
+
+![Screen shot of home screen of goknights](./assets/screenshots/app_overview.jpg)
+
+This project is currently under development and will be updated periodically.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Getting Started
 
-This project is a starting point for a Flutter application.
+Below are some brief instructions on setting up this project locally. To get a local copy up and running follow these simple example steps.
+
+### Prerequisites
+
+* [Flutter SDK](https://flutter.dev/docs/get-started/install) for cross-platform development
+* [Xcode](https://developer.apple.com/xcode/) and [CocoaPods](https://cocoapods.org/) for iOS dependencies
+* [Android Studio](https://developer.android.com/studio) for Android dependencies
+* Your preferred code editor (I use [Visual Studio Code](https://code.visualstudio.com/))
+
+### Installation
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/popoway/goknights.git
+   ```
+2. Install dependency packages
+   ```sh
+   flutter pub get
+   ```
+3. Enter your API keys in `.env`
+4. You're all set! Run the app with `flutter run` or your preferred editor.
+
+To generate a _release_ build for iOS without codesign, run the following command:
+```
+flutter build ios --release --no-codesign
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Contributing
 
-A few resources to get you started if this is your first Flutter project:
+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 found a bug or 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
+
+Feel free to [open an issue](https://github.com/popoway/goknights/issues/new) for bug reports, and your suggestions on how this app can be improved.
+
+Pull requests: If this is your first Flutter/Dart project, below are a few resources to get you started:
 
 - [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
 - [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
@@ -15,7 +102,28 @@ For help getting started with Flutter development, view the
 [online documentation](https://docs.flutter.dev/), which offers tutorials,
 samples, guidance on mobile development, and a full API reference.
 
-To generate a release build for iOS without codesign, run the following command:
-```
-flutter build ios --release --no-codesign
-```
+To report a security vulnerability, please review the [Security Policy](https://github.com/popoway/goknights/blob/main/SECURITY.md).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Privacy
+
+This app does not use cookies or similar technology to deliver its services and to analyze traffic. The app author respects your privacy. Please review the [Privacy Policy](https://github.com/popoway/goknights/blob/main/PRIVACY.md) for more information on how your data is handled.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## License
+
+[GNU General Public License v3.0](https://github.com/popoway/goknights/blob/main/LICENSE)
+
+Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.
+
+Open Source Licenses and Acknowledgements are available within the "About" dialog of the app.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Disclaimer
+
+"Disclaimer: While I am both an employee of Queens College and a graduate student in Computer Science here, the "GoKnights" app is a personal project developed during my summer break. The content, views, and opinions expressed within the app are solely my own and do not reflect the positions, strategies, or opinions of Queens College. This app is neither officially associated with nor maintained by Queens College as part of my employment."
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>

SECURITY.md

@@ -0,0 +1,22 @@
+# Security Policy
+
+## Supported Versions
+
+This section lists which versions of this project are currently being supported with security updates.
+
+| Version    | Supported          |
+| ---------- | ------------------ |
+| 1.0.0      | :white_check_mark: |
+| < 1.0.0    | :x:                |
+
+## Reporting a Vulnerability
+
+For the protection of our customers, we doesn't disclose, discuss, or confirm security issues until an investigation has occurred and patches or releases are generally available. [This document](https://github.com/popoway/goknights/commits/main) lists recent releases. 
+
+To report a security or privacy vulnerability, please send an email to [email protected] that includes: 
+
+- The specific product and software version(s) which you believe are affected
+- A description of the behavior you observed as well as the behavior that you expected
+- A numbered list of steps required to reproduce the issue and a video demonstration, if the steps may be hard to follow
+
+You'll receive an automatic reply which acknowledges that we received your report, and we’ll contact you if we need more information.

android/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
+#Fri Aug 25 05:00:01 EDT 2023
 distributionBase=GRADLE_USER_HOME
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
 distributionPath=wrapper/dists
-zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-all.zip
+zipStoreBase=GRADLE_USER_HOME

ios/Runner.xcodeproj/project.pbxproj

@@ -491,6 +491,7 @@
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_KEY_CFBundleDisplayName = GoKnights;
 				INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.education";
+				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
@@ -672,6 +673,7 @@
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_KEY_CFBundleDisplayName = GoKnights;
 				INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.education";
+				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
@@ -697,6 +699,7 @@
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_KEY_CFBundleDisplayName = GoKnights;
 				INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.education";
+				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",

lib/aboutapp.dart

@@ -73,7 +73,8 @@ class _AboutAppPageState extends State<AboutAppPage> {
                     .textTheme
                     .navLargeTitleTextStyle),
             // text display app version
-            Text('Version: ${_packageInfo.buildNumber}',
+            Text(
+                'Version: ${_packageInfo.version} (${_packageInfo.buildNumber})',
                 style: TextStyle(
                     color: const CupertinoDynamicColor.withBrightness(
                       color: CupertinoColors.black,
@@ -82,7 +83,7 @@ class _AboutAppPageState extends State<AboutAppPage> {
                     fontSize: 12)),
             Container(
               padding: const EdgeInsets.all(16),
-              child: Text('© 2023 All rights reserved.',
+              child: Text('© 2023 Ming Lei. All rights reserved.',
                   style: TextStyle(
                       color: const CupertinoDynamicColor.withBrightness(
                         color: CupertinoColors.black,
@@ -93,12 +94,7 @@ class _AboutAppPageState extends State<AboutAppPage> {
             CupertinoButton(
               child: const Text('Privacy Policy'),
               onPressed: () => _launchURL(
-                  'https://www.calendarwiz.com/mobile.html?crd=queenscollege&nolognavbar=1&cid[]=all#'),
-            ),
-            CupertinoButton(
-              child: const Text('Terms of Use'),
-              onPressed: () => _launchURL(
-                  'https://www.calendarwiz.com/mobile.html?crd=queenscollege&nolognavbar=1&cid[]=all#'),
+                  'https://github.com/popoway/goknights/blob/main/PRIVACY.md'),
             ),
             CupertinoButton(
               child: const Text('Open Source Licenses'),

lib/main.dart

@@ -14,6 +14,7 @@ class MyApp extends StatelessWidget {
   Widget build(BuildContext context) {
     return const CupertinoApp(
       title: 'GoKnights',
+      debugShowCheckedModeBanner: false,
       theme: CupertinoThemeData(
         primaryColor: Color(0xFFE71939),
         primaryContrastingColor: CupertinoColors.white,

pubspec.yaml

@@ -1,5 +1,6 @@
 name: goknights
-description: A new Flutter project.
+description: QC Knights experience, elevated
+repository: https://github.com/popoway/goknights
 # The following line prevents the package from being accidentally published to
 # pub.dev using `flutter pub publish`. This is preferred for private packages.
 publish_to: 'none' # Remove this line if you wish to publish to pub.dev
@@ -16,7 +17,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev
 # https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
 # In Windows, build-name is used as the major, minor, and patch parts
 # of the product and file versions while build-number is used as the build suffix.
-version: 1.0.0
+version: 1.0.0+5
 
 environment:
   sdk: '>=3.1.0 <4.0.0'