Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
phanxuanquang authored Aug 3, 2024
1 parent d037827 commit 59ba731
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
![Untitled-2-Recovered](https://github.com/user-attachments/assets/9b2c68a8-0ba2-4655-9c7f-3ce227c8eb86)

EngAce is a cutting-edge, generative AI-powered application designed to revolutionize the way Vietnamese learn English. This app provides a personalized learning experience tailored to each user's unique needs and preferences. EngAce combines the power of artificial intelligence with a comprehensive set of features to create an engaging and effective English learning environment. This repository contains the full source code, documentation, and resources for the EngAce app.
____________________________

## :raising_hand_man: Our Team
Expand All @@ -8,39 +10,43 @@ ____________________________
| 2 | [Bui Minh Tuan](https://github.com/tuan20520342 "Bùi Minh Tuấn") | Frontend Development |
| 3 | [Mai Tan Ha](https://github.com/maitanha "Mai Tan Ha") | Business Management, Machine Learning Researcher |

## :lock: Data Privacy Statement
Your data, including your Gemini API Key and Google account information, is securely stored on your personal device only. This data will be automatically deleted from our system when you log out of the application. We do not store or retain your data on our servers, ensuring that your information remains private and secure at all times.

If you have any concerns or questions about our data privacy practices, please feel free to open a new issue.

## :triangular_flag_on_post: License

This project is licensed under the **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International** license. See the [LICENSE](./LICENSE) file for details.
____________________________

## 1. Overview
EngAce is a cutting-edge, generative AI-powered application designed to revolutionize the way Vietnamese learn English. This app provides a personalized learning experience tailored to each user's unique needs and preferences. EngAce combines the power of artificial intelligence with a comprehensive set of features to create an engaging and effective English learning environment. This repository contains the full source code, documentation, and resources for the EngAce app.

## 2. Features
## :rotating_light: Features
EngAce offers a suite of tools and functionalities aimed at making English learning more accessible, enjoyable, and efficient. The app is designed with four main features as below.

### 2.1 AI Dictionary
### 1. AI Dictionary
The AI Dictionary is a powerful tool that allows users to look up definitions in both English-to-English and English-to-Vietnamese formats. Key features include:
- Illustrative Examples: Each definition comes with example sentences to help users understand the word in context.
- Contextual Search: Users can search for words based on specific contexts, making it easier to understand different usages of a word.

### 2.2. Practice Exercises
### 2. Practice Exercises
EngAce provides personalized practice exercises to help users improve their English skills. Features include:
- Custom Quizzes: Users can generate multiple-choice quizzes tailored to their proficiency level and the topics they want to practice.
- Adaptive Learning: The app adapts to the user's performance, providing progressively challenging questions to ensure continuous improvement.

### 2.3. Writing Assistant
### 3. Writing Assistant
The AI Writing Assistant is designed to help users enhance their writing skills through real-time feedback and suggestions. Features include:
- Writing Review: Users can submit their writing pieces and receive detailed feedback on grammar, style, and coherence.
- Improvement Suggestions: The AI provides constructive suggestions to help users refine and improve their writing.

### 2.4. Chat with AI Expert
### 4. Chat with AI Expert
EngAce includes an AI-powered chatbot that acts as an English learning companion. Features include:
- Interactive Discussions: Users can engage in conversations with the chatbot on various English learning topics.
- Learning Tips: The chatbot provides tips and advice to help users overcome common learning challenges.
- Q&A Support: Users can ask the chatbot questions related to English learning and receive informative answers.

## :lock: Data Privacy Statement
Your data, including your Gemini API Key and Google account information, is securely stored on your personal device only. This data will be automatically deleted from our system when you log out of the application. We do not store or retain your data on our servers, ensuring that your information remains private and secure at all times.

If you have any concerns or questions about our data privacy practices, please feel free to open a new issue.

## :open_hands: Contribution
We welcome contributions and encourage you to help this project better and better. If you encounter any issues or have suggestions for improvements, please open an issue in the [Issues](https://github.com/phanxuanquang/EngAce/issues) section of the repository.
Before submitting a pull request, please ensure that your changes are well-documented in the Pull Request description.

Thank you for your contribution and for helping to make this project better! :tada:


0 comments on commit 59ba731

Please sign in to comment.