Skip to content

popoway/goknights

Repository files navigation

wakatime GitHub code size in bytes GitHub language count GitHub last commit (branch) GitHub Actions Workflow Status GitHub Release


GoKnights logo

GoKnights

Your Queens College Knights experience, elevated
Explore the docs »

Get it on Google Play Download on the App Store Available on Apple TestFlight
View Demo · Report Bug · Request Feature

📢 GoKnights is featured on The Knight News, Queens College's monthly publication! Read Coverage

Table of Contents

Description

Inspired by numerous inquiries and questions from incoming freshmen during new student orientation this summer, and the lack of official college app, GoKnights 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

This project is currently under development and will be updated periodically.

(back to top)

Getting Started

Below are some brief instructions on setting up this project locally. To get a local copy up and running follow these simple example steps.

🛑 If you only want to download and use the app your phone, not code and debug it, you should scroll up and use one of these buttons instead. 🛑

Prerequisites

Installation

  1. Clone the repo
    git clone https://github.com/popoway/goknights.git
  2. Install dependency packages
    flutter pub get
  3. Enter your API keys in .env:
    # example .env file
    GOOGLE_MAPS_API_KEY=your_key_here
    UPLOAD_KEYSTORE_PASSWORD=google_play_keystore
    OPENAI_API_ENDPOINT=your_endpoint (ex. api.openai.com)
    OPENAI_API_KEY=your_api_key
    OPENAI_API_MODEL=gpt-4o-mini
    
  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

To build an Android app bundle for submission, run the following command:

flutter build appbundle

(back to top)

Roadmap

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 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 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:

For help getting started with Flutter development, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

To assist with translations, please review the Localization Guide.

To report a security vulnerability, please review the Security Policy.

(back to top)

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 for more information on how your data is handled.

(back to top)

License

GNU General Public License v3.0

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.

(back to top)

Acknowledgements

Programming Ming Lei
Graphics
Translation: Chinese
Translation: Spanish Chris Galarraga
Translation: Hebrew Sofia Taherkhani
Launy Schweiger
Translation: Hindi Vidhi Maradia
Beta Testers Allan Edmond
Arina Logosh
Brian Flores
Callie Podias
Chris Galarraga
Daniel Yakubov
Erika Guadalupe
Riyahauna Headley
Sayashmini Madhow
Marketing @qcareers
@qclearningcommons

Special thanks to the following departments at Queens College for their support and guidance:

(back to top)

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."

The SA logo is utilized under the permission of the Queens College Student Association.

(back to top)