jangascodingplace / kumon-math-app Goto Github PK
View Code? Open in Web Editor NEWHome Page: https://kumon-math-app.readthedocs.io/
License: GNU General Public License v3.0
Home Page: https://kumon-math-app.readthedocs.io/
License: GNU General Public License v3.0
Goal:
write a GeneratorClass which generates tasks for multiplications with numbers from 0 - 10
e.g.
0 * 1
3 * 5
7 * 8
Goal:
Optimize the generator. It should only create tasks which results in values greater or equal than 0
Develop user interfaces allowing pupils to submit solutions for math tasks using three methods:
For versatility and catering to different user preferences, the kumon-math-app
will provide three methods for pupils to submit their answers. This approach not only makes the app more inclusive but also prepares the groundwork for future AI validation of handwritten and image-based solutions.
Write a generator class which generates tasks which multiply values between 10 and 9999
e.g.
98 * 105
302 * 7831
Define and document clear standards for creating and managing tickets related to technical documentation. These standards will ensure consistency, clarity, and effectiveness in conveying the requirements and scope of documentation-related tasks.
As the project grows, so does the importance of well-maintained technical documentation. Ensuring that our documentation tickets adhere to specific standards will make the documentation process smoother, clearer, and more efficient for both writers and developers.
These standards aim to streamline our documentation process and improve clarity. As with all processes, it's essential to remain flexible and open to changes based on practical experiences and feedback.
Write a Generator Class which generates tasks for complex additions with numbers between 100 and 9999
e.g.
982 + 341
1952 + 221
Set up a fundamental project structure for the kumon-math-app
. As part of this structure, ensure there's a clear process for adding new mathematical tasks. Begin with the implementation of a rudimentary layout to offer a tangible starting point for the app's development.
To streamline our development process and ensure consistency across contributions, we need a foundational project skeleton. This basic structure will serve as the blueprint for the app, making it easier for developers (especially newcomers) to contribute and understand the project's flow.
Given our team's diverse experience levels, prioritize clarity and simplicity in both the project structure and the guide. A straightforward setup now will reduce complexities and challenges as the project progresses.
Develop a markdown-based documentation that outlines and explains the Kumon learning method for the benefit of our development team, especially junior members.
While the kumon-math-app
will use the Kumon learning method as a foundational approach, there's a need for a clear and concise documentation that team members can refer to, ensuring everyone understands the core concept behind the app's functionality.
Create a comprehensive documentation that covers:
Upon reading the markdown document, any team member, irrespective of their prior knowledge about Kumon, should:
kumon.md
file is added to docs/kumon.md
Ensure the document is beginner-friendly, given our team's experience level. Use clear and straightforward language. If there are technical terms related to Kumon, consider adding a small glossary or definitions section.
Review the existing documentation on prerequisites, setup, and quick start for the kumon-math-app
. Test its clarity, ease of understanding, and completeness. If any discrepancies or improvements are identified, extend and refine the documentation accordingly.
To ensure a smooth onboarding process for developers and contributors, it's essential that our documentation is both comprehensive and clear. This task is designed to validate the user-friendliness of our documentation by having real users test and potentially refine it.
kumon-math-app
for the first time. Ensure that by following the documentation, the app sets up successfully without hiccups.kumon-math-app
without external assistance or resources.Create a class which generates a tasks to substract two numbers between 100 and 9999. Make sure that your task has only positive values as solution
e.g.
Create and formalize standards for generating and handling tickets related to non-technical documentation. The goal is to ensure consistency, clarity, and understandability across all documentation tasks that cater to non-technical audiences or purposes.
As the project expands, there is a growing need for non-technical documentation to guide, inform, and communicate with audiences outside of the development team, such as end-users, stakeholders, or new team members. Having a consistent approach to these documentation tasks will make the process more streamlined and effective.
non-technical-documentation-guide.md
file is added to docs/contributing/non-technical-documentation-guide.md
The aim of these standards is to bridge the gap between technical and non-technical audiences. It's vital to stay adaptable and receptive to changes based on real-world application and feedback.
Conduct comprehensive research on potential OCR solutions suitable for our React Native application. The goal is to evaluate and shortlist feasible solutions, such as tensorflow.js or other OCR libraries/tools, that can later be integrated into our app.
To enhance our app's capabilities, we are looking into adding an OCR feature. Before diving into implementation, we need to understand the landscape of available OCR tools, their compatibility with React Native, performance metrics, and other crucial considerations.
This research phase is critical for laying a solid foundation for the subsequent implementation phase. The focus should be on gathering objective data and insights to make an informed decision.
Write a generator class which divides two bigger numbers and will end in integer values.
e.g.
Develop an overview page that provides a clear list of available math task profiles. Users should be able to view different profiles and their associated task types. Clicking on a task type should allow users to interact with the selected task type directly.
To provide a comprehensive learning experience, various math task profiles (e.g., "5-simple", "10-simple") are established, each comprising specific task types. An overview page is essential for users to navigate and select the desired profile and task type for practice or examination.
This feature will be only used for development purposes and will be removed on later versions again.
Develop a markdown-based documentation detailing the motivation and background of the kumon-math-app
project, ensuring every team member, especially our newcomers, comprehend why and how this project came to life.
The kumon-math-app
is a unique project developed by the A-levels class of a German school. This project signifies the culmination of a year-long journey undertaken by students who hadn't experienced programming before. The idea was proposed by the class teacher, who envisioned creating an app based on the Kumon learning method.
Generate a markdown (.md) file with the following sections:
kumon-math-app
was conceived.After engaging with the documentation, readers should:
motivation.md
file is added to docs/motivation.md
We will have a testing phase. No one knows exactly how students will use the app and what their handwriting will look like. Therefore, a WebAPI will be provided for this phase. When a student completes a task, the image including the task will be sent to an API.
Please create only a single post endpoint. It should retrieves the following body:
{
"task": {
"id": "simple-addition",
"generated-task": "2 + 7"
},
"img": BASE_64_ENCODED_IMAGE
}
The image should be stored on the API-Server System then.
Create a generator class which divides two numbers. Make sure that your result can only be integer numbers
e.g.
The Task Views Header and Footer should be redesigned.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.