Welcome to AddToAnki 👋

AddToAnki, a Japanese pop-up dictionary extension for Chrome, like yomichan. Given that Yomichan is no longer under maintenance, I initiated this endeavor for my personal needs. The project employs AI to substitute the conventional dictionary functionality. However, it's worth noting that the AI's precision might not be on par with that of traditional dictionaries.

AddToAnki provides advanced features :

Use AI to explain words
More nature audio
Automatic note creation for the Anki flashcard program via the AnkiConnect plugin.

Installation

Basic Usage

Contribution Guidelines

1. Overview

Before contributing, please follow these steps:

Clone the Project

Use the following command to clone the project's GitHub repository to your local machine.
```
git clone https://github.com/erzhiqianyi/AddToAnki.git 
```
Install Dependencies

Navigate to the project directory and install the required dependencies.
- Installing Node.js And npm
  
  Using Node.js to run JavaScript, npm to install and manage dependencies.
```
  # Verify installation
  node --version
  npm --version
```
- Setting Up Vue CLI
  
  Vue CLI is a command-line tool for scaffolding Vue.js projects
```
  # Install Vue CLI
  npm install -g @vue/cli

  # Verify installation
  vue -V 
```
- Installing dependencies
```
nmp install
```
- Installing Vue.js devtools
  
  The Vue.js devtools extension is a browser extension for Chrome and Firefox that allows you to inspect and debug your Vue.js applications.
  
  Vue.js devtools
Understand Project Structure

Make sure you understand the project's structure and organization. You can refer to our documentation for more information.

2. Choose a Task

You can contribute by selecting one or more of the following tasks:

Feature Enhancement

If you have new feature ideas or suggestions for improving existing features, please propose them in our issue tracker and await approval.
Bug Fixes

You can check the issue list in our issue tracker and attempt to fix any reported bugs.
Documentation

Help improve project documentation, including code comments, the README file, and user guides.
Testing

Write test cases to ensure the stability and performance of the extension.

3. Create a Branch

Before starting work, create a new branch to avoid affecting the main branch. Use a descriptive branch name like feature/your-feature or bugfix/issue-number.

4Installing . Write Code

Work on your branch and write code according to the task you've chosen. Ensure you follow the project's coding style and standards.

5. Testing

Before submitting, make sure your changes pass the project's tests. If you're adding new features, be sure to write appropriate unit tests.

6. Submit a Pull Request

Once you've completed your task and passed the tests, submit a pull request (PR). Provide a clear title and description explaining the purpose and content of your changes.

7. Review and Merge

Our team will review your pull request and provide feedback if necessary. Once your contribution is reviewed and approved, it will be merged into the main branch.

8. Acknowledgment

Once your contribution is merged, you will be listed as a contributor to the project and acknowledged in the contributors' list.

Need Help?

If you have any questions, concerns, or need further assistance, please don't hesitate to reach out to us. You can contact us through the following channels:

Project Issue Tracker: AddToAnki Issues

Email: addtoanki@erzhiqian.cc

We welcome your contributions and thank you for being a part of this project, making it better together!

Licenses

MIT License

Copyright (c) 2023 二之前一

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Third-Party Libraries

AddToAnki uses several third-party libraries to function. Below are links to homepages, snapshots, and licenses of the exact versions packaged.

Author

👤 erzhiqianyi

Website: https://erzhiqian.cc
Twitter: @erzhiqianyi
Github: @erzhiqianyi

Show your support

Give a ⭐️ if this project helped you!

This README was generated with ❤️ by readme-md-generator

erzhiqianyi / AddToAnki