Table of Contents

1. About The Project
   • Key Feature
   • Future Feature
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Key Features

• Gamify boring questions
  • With this feature, teachers can pass in boring question files and Testeria will automatically convert it to fun card games to make students pay attention to the lesson.
• Hero profile
  • Just like a character in a RPG game, each user will earn coins as a reward when finish the quiz game with high score. User can use coins to buy gun, skin for their own character.
• Quiz game:
  • The questions from teacher files will be transformed into a card game that take idea from dungeon. User's character have to choose which card to take.
  • If user choose monster card, a question will pop up and the animation of hero slaying monster will be played if user choose the correct answer.
  • If user choose buff card, special buff will be given such as increasing health, increasing damage.
• Clan:
  • A place where many players can join and experience clan games to gain coins and knownledge. Players can also contribute their own questions to clan.
  • Can be used by teachers for their class to track each student progress and accuracy to support them.
• Generated questions from documents:
  • Reduce the time needed to prepare questions by summarizing documents and then return a list of questions related to the documents.

Future Features

• [ ] Review game - Players can join older games to review their lessons and pratice.
• [ ] Implement new enviroments, mobs.
• [ ] Increase types of answer.
• [ ] Imporve scalability.
• [ ] Reduce the time to convert question files to game.

(back to top)

Persona:

Name: Minh Nguyen
Age: 25
Occupation: Software Engineering Student
Interests: Learning and self-improvement

Reason for Using the App:
Minh is a passionate software engineering student who is constantly seeking opportunities to enhance his knowledge and skills. He regularly participates in online courses and self-studies through books and online resources. Minh believes that using a learning app can help him to flexibly and engagingly self-assess his knowledge.

Habits:
Minh is a self-disciplined individual with a high sense of responsibility towards his studies. He dedicates a portion of his daily time to revise and reinforce his knowledge. Minh enjoys leveraging technology to aid his learning process and is eager to explore new apps to find the most suitable solution for his learning needs.

User Stories:

1. As a user, I want an app that provides multiple-choice questions on various topics to assess my knowledge.
2. As a user, I want the app to generate quizzes automatically from a list of provided questions.
3. As a user, I want to play quiz games to both entertain myself and enhance my knowledge.
4. As a user, I want the app to provide hints or explanations for questions I answered incorrectly to learn from my mistakes.
5. As a user, I want the app to store the results of my quizzes or games to track my learning progress.

Non-functional Requirements:

1. Performance: The app must have quick response times to ensure users do not experience long waits while taking quizzes or playing games.
2. Compatibility: The app should be compatible with popular mobile devices and operating systems such as iOS and Android.
3. User Interface: The app's interface should be user-friendly, easy to navigate, and visually appealing to attract users.
4. Security: Personal data and user results must be securely protected to prevent unauthorized access.
5. Reliability: The app should operate stably and reliably without frequent errors or disruptions.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• [x] Add Changelog
• [x] Add back to top links
• [ ] Add Additional Templates w/ Examples
• [ ] Add "components" document to easily copy & paste sections of the readme
• [ ] Multi-language Support
  • [ ] Chinese
  • [ ] Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Nguyen Quy Dang - @your_twitter - dangnq2501@gmail.com

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)