/UniQuery

An open source project that provides quora like solutions to universities

Primary LanguageC++BSD 2-Clause "Simplified" LicenseBSD-2-Clause

UniQuery (Flutter Version)

UniQuery is a mobile application designed exclusively for university students, providing a platform where they can post queries and receive answers from peers within their university community. This app fosters knowledge sharing, community building, and valuable connections among students.

Project Structure

Here's an overview of the project structure:

  • -uniquery/
    • -android: Native Android code and configuration.
    • -ios: Native iOS code and configuration.
    • -lib/: Dart code for the mobile application.
      • -models: Data Models (Data classes).
      • -screens: Screen widgets.
    • test: Unit and widget tests.
    • assets: Static assets like images, fonts, and JSON files.
    • build: Build artifacts (automatically generated).
    • pubspec.yaml: Flutter project configuration.
    • README.md: Project-specific documentation (this file).

Tech Stack

The tech stack used in UniQuery includes:

  • Flutter: Cross-platform UI toolkit for building natively compiled applications for mobile from a single codebase.
  • Google Firebase: Backend services for mobile applications, including authentication, real-time databases, and cloud storage.
  • Riverpod: A simple way to manage state in Flutter, recommended for this project.

Before contributing look into CONTRIBUTING GUIDELINES

Our Code of Conduct: CODE OF CONDUCT

How to Contribute

Celebrate Hacktoberfest with us by contributing to UniQuery! Follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine: git clone https://github.com/gdsc-jssstu/UniQuery.git
  3. Navigate to the project directory: cd UniQuery
  4. Install project dependencies using Flutter Package Manager: flutter pub get
  5. Create a new branch for your contribution: git checkout -b feature/your-feature-name

Development

  • Make your changes or additions to the codebase. Make sure you are following the standards recommended by flutter. Test your changes to ensure they work as expected. To run the app on your emulator:

    flutter run

  • Commit your changes with a descriptive commit message:

    git commit -m "Add your descriptive message here"

Push Changes

  • Push your changes to your forked repository on GitHub:

    git push origin feature/your-feature-name

Getting Started with Contributions

  • Create a Pull Request (PR)

Visit the UniQuery repository on GitHub. Click the "Compare & pull request" button next to your recently pushed branch. Follow the PR template and guidelines. Provide details about your changes. Submit the PR.

  • Review and Merge

The maintainers will review your PR and may request changes or provide feedback. Once your PR is approved, it will be merged into the main repository.

Final version of the project

Click here for the UI design and prototype of the project. Feel free to improvise this design.

Hacktoberfest

Celebrate Hacktoberfest by contributing to open source projects! This project is participating in Hacktoberfest, a month-long celebration of open-source software. To learn more and sign up for Hacktoberfest, visit the official website.

Maintainers

  1. Aditya T

Thank You

Thank you for contributing to UniQuery and being a part of Hacktoberfest! Your efforts help make this project better for university students. If you have any questions or need further assistance, please don't hesitate to reach out.

Happy coding!