/QGen

Basic Arithmetic Questions Generator is an Android app that generates custom arithmetic questions with two numbers, operation, layout, max value, and rows/columns. Built with Material 3 design, Kotlin, and XML, it's ideal for teachers, students, and parents.

Primary LanguageKotlin

Basic Arithmetic Questions Generator - QGen

Introduction

Basic Arithmetic Questions Generator is an offline Android application that generates arithmetic questions for users. The questions include two numbers with a range that can be specified by the user, and the operation can be selected from four basic operations: addition, subtraction, multiplication, and division. The application is based on Material 3 design language, Kotlin, and XML.

Features

Generate arithmetic questions with two numbers Customize the range of two numbers Choose the operation for the questions Select between two basic layouts: vertical and horizontal Set max value for the result of any question generated Generate questions with a specified number of rows and columns

Screenshots

1. horizontal Layout

photo_2023-02-14_16-50-24 photo_2023-02-14_16-50-22 photo_2023-02-14_16-50-21

2. Vertical Layout

photo_2023-02-14_16-50-24 photo_2023-02-14_16-50-22 photo_2023-02-14_16-50-21

Installation

  1. Clone the repository to your local machine.
  2. Open the project in Android Studio.
  3. Build and run the application on your Android device or emulator.

Technologies and Libraries

  1. Material 3 design language
  2. Kotlin
  3. XML
  4. GridView

Architecture and Design

The application is designed using a Model-View-Controller (MVC) architecture. The model is responsible for generating arithmetic questions, and the view is responsible for displaying them to the user. The controller handles user interactions and manages the communication between the model and the view.

The user interface is designed using XML layouts and Material 3 design language. The application logic is written in Kotlin, which is a modern, concise, and expressive language that is designed to work seamlessly with Java.

Getting Started

To generate arithmetic questions, follow these steps:

  1. Open the application on your Android device or emulator.
  2. Select the range for two numbers.
  3. Choose the operation for the questions.
  4. Select the layout for the questions.
  5. Set the max value for the result of any question generated.
  6. Enter the number of rows and columns for the questions.
  7. Press the "Generate" button to generate the questions.

FAQ

Q: Can I generate questions with decimal numbers?

A: No, the application generates questions with whole numbers only.

Q: Can I save the generated questions?

A: No, the application does not have a feature to save the generated questions.

Troubleshooting

If you encounter any issues while using the application, try the following:

Check that you have entered valid inputs for the range of two numbers, the max value, and the number of rows and columns. Make sure that you have selected a valid operation and layout. Restart the application or your device if the application becomes unresponsive. Known Issues None at this time.

Contribution Guidelines:

Thank you for your interest in contributing to Basic Arithmetic Questions Generator! Your contributions are highly appreciated and will help improve the application for all users.

Before you begin contributing, please read the following guidelines:

  1. Fork the repository and create a new branch for your contribution.
  2. Follow the coding style and standards used in the existing codebase.
  3. Clearly document any new code or changes made to existing code.
  4. Test your changes thoroughly before submitting a pull request.
  5. Submit a pull request to the development branch of the main repository.
  6. Wait for feedback and address any issues raised during the review process.

Reporting Issues:

If you encounter any issues while using the application, please report them on the GitHub repository issue tracker. When reporting an issue, please include as much detail as possible, including steps to reproduce the issue, expected behavior, and any error messages or screenshots.

Contributing Code:

When contributing code, please follow these guidelines:

  1. Use clear and descriptive variable and function names.
  2. Keep functions short and focused on a single task.
  3. Avoid code duplication and use common functions or classes whenever possible.
  4. Use comments to explain any complex or unclear code.
  5. Test your code thoroughly before submitting a pull request. Thank you for your contributions! Together, we can make Basic Arithmetic Questions Generator an even better application.

GitHub Repository: https://github.com/sunkusaarthak/QGen.git

License

This project is licensed under the MIT License - see the LICENSE file for details.