Embedding QuML player in front end framework React Native

sajeshkayyath commented 1 year ago

Project Details

What is Sunbird inQuiry?

Sunbird inQuiry is a software building block that enables setting up of question banks for various use cases such as assessments, quizzes, practice worksheets, surveys, and many more. These are applicable in multiple domains related to education and human development.

Here are some examples of solutions that can be enabled through Sunbird inQuiry:

Conduct assessments which can evaluate users’ understanding of concepts and issue certificates based on assessment score.
Evaluate assessment data to take informed decisions and plan for interventions.
Launch surveys to collect feedback and analyse responses.

Question Set Player (QuML player)

Question set player is a player provided by inQuiry to create engaging & inclusive experiences for end users consuming the question sets.

More details are here

Features to be implemented

Embedding QuML player in front end framework React Native

QuML player is build as a web component and as part of this use case, we need to prepare a working version of QuML player using React Native. Currently our application is build on Angular and is not leveraging the web component of the player. With this in place, developers can leverage the player in the React Native applications and enhance the functionalities to meet their specific needs.

What exists

Angular version of the application using the QuML player library
QuML Player is available as web component
Backend APIs that is needed for the application to function

What needs to be build

[ ] React native application embedding QuML player
[ ] Fixing any integration issues while embedding the QuML player

Learning Path

Complexity Medium

Skills Required React Native

Name of Mentors @rajnishdargan

Project size 2 Weeks

Product Set Up

Instruction to install the application is available here

Acceptance Criteria

[ ] QuML player is able to play all the questions in the React Native application
[ ] User is able to go through all the questions in the question set and answer

Out of Scope

Enhancing the existing angular application

Milestones

[ ] Understanding the requirements
[ ] Understanding QuMl Player
[ ] Setting up the app
[ ] Understanding the web component of QuML Player
[ ] Embedding the QuML Player inside the React Native application
[ ] Testing the application to cover the use cases

AbhiiNaithani commented 1 year ago

Hey @sajeshkayyath , I've found this project great and would like to contribute in this. I've some earlier experience in react-native app development and want to improve my skills through this project. Please guide me.

Abro0058T commented 1 year ago

Hey @sajeshkayyath , I saw the project and would like to contribute in this . I've experience in react-native and would like to contribute in this project and enhance my skills

chandra-pro commented 1 year ago

Hey @sajeshkayyath , I am interested to contribute in this project . I've already resolved some issue in one of the GovTech project using React Native.

Amit2508 commented 1 year ago

Is any issue open ?

ayushtiwari110 commented 1 year ago

Hey There! @sajeshkayyath I trust this correspondence finds you well. My name is Ayush Tiwari, and I am an Undergraduate student currently enrolled at the esteemed Indian Institute of Technology, Bhubaneswar. I just gone through this issue and I firmly believe that my proficiencies in React Native and other associated web technologies make me well-suited to contribute to its resolution.

Within the confines of my academic institution, I have had the privilege of engaging in the development of practical projects utilizing frameworks like ReactJS and React Native. These endeavors have equipped me with valuable experience in constructing applications that resonate with real-world demands. I had made two real world applications based on React Native. Moreover, I possess a commendable understanding of UI/UX design principles, further bolstering my capability to make valuable contributions.

In light of my qualifications and enthusiasm for this undertaking, I am eager to submit a comprehensive proposal outlining my strategic approach to the project. This detailed plan will elucidate my thought process and demonstrate how my involvement can be of utmost value to the initiative.

Thank you for dedicating your time to reviewing this communication. I look forward to the opportunity to contribute to the project and eagerly await your favorable response.

sandeepB3 commented 1 year ago

Can anyone help me with this issue ? Is this 'https://staging.sunbirded.org/api/question/v1/list' api working? I am trying to use quml player as a web component and when I make request to the above url to get list of questions it shows error. Any other API is there ?

vaibhavbhuva commented 1 year ago

Can anyone help me with this issue ? Is this 'https://staging.sunbirded.org/api/question/v1/list' api working? I am trying to use quml player as a web component and when I make request to the above url to get list of questions it shows error. Any other API is there ?

@sandeepB3 Please share more details on what error you are getting so we can help you the same.

vaibhavbhuva commented 1 year ago

Hi All, Thanks for your interest in our project. please do setup the application locally, also make sure to prepare and submit your proposal in unstop platform and join discord channel for continuous updates.

Please check out the C4GT website on how you can contribute: https://www.codeforgovtech.in/.

turingAlan commented 1 year ago

Hi @vaibhavbhuva, I found this project really interesting as I have been developing both android and iOS application using react native for more than 2 years for my clients now, I would also like to try my hands on open-source contribution. Looking forward towards contributing in this project.

vaibhavbhuva commented 1 year ago

@turingAlan Thanks for showing interest in this project. Please check out the C4GT website on how you can contribute: https://www.codeforgovtech.in/.

Sunbird-inQuiry / player