Euskalbar

Basque translator's friend. Dictionaries, glossaries, corpora and more at one click.
Addon Webpage · Report a Bug or Request a Feature

Euskalbar is a browser extension designed to facilitate the translation of words and phrases between Basque and other languages. Born out of a passion for promoting the Basque language and making it more accessible to a global audience, Euskalbar aims to provide a seamless translation experience for users.

• Multiple Dictionaries: Access a variety of dictionaries and resources to get the most accurate translations.
• User-friendly Interface: A clean and intuitive interface ensures users can easily navigate and use the extension.
• Customizable Settings: Tailor the extension's behavior according to your preferences.
• Statistics & Analytics: Gain insights into your translation habits and frequently used dictionaries.

The Basque language, known as Euskara, is one of the oldest languages still spoken today. With a rich history and unique linguistic characteristics, it's a treasure that deserves preservation and promotion. Euskalbar is our contribution to this cause, aiming to bridge the gap between the Basque language and the world.

(back to top)

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.

To be able to test the extension, you need Mozilla's web-ext .

• npm

  npm install web-ext@latest -g

1. Go inside the src folder of the downloaded code.
2. Run web-ext run (more info on the web-ext tool)

You can create the extension file in one of two ways:

• zip -r ../euskalbar-0.0.zip *. You will get a ZIP file named "euskalbar-0.0.zip" (change the 0.0 part of the name to what you need; the real version number is defined in the "src/manifest.json" file).
• web-ext build -a ... You will get a ZIP file named "euskalbar-0.0.zip", with the real version number defined in the "src/manifest.json" file instead of the 0.0 part of the name).

The built extension can be installed and run in Developer Edition, Nightly, and ESR versions of Firefox, after toggling the "xpinstall.signatures.required" preference in "about:config".

For installation in any Firefox, extension has to be signed (more info here).

Below are the instructions on how to download and test the extension in Firefox Developer Edition.

1. Clone the repo and enter the root folder

   git clone https://github.com/euskalbar/euskalbar.git

2. Go to src folder

   cd src

3. Install NPM packages

   npm install

4. Test the extension

   web-ext run

   (more info on the web-ext tool)

The extension can be zipped to a file with the web-ext NPM package.

web-ext build -a ..

(back to top)

We appreciate your interest in contributing to Euskalbar! Whether you're fixing bugs, adding new features, or improving documentation, your efforts will make a significant impact. Follow the steps below to contribute:

• Navigate to the Euskalbar repository on GitHub.
• Click the "Fork" button in the top-right corner. This will create a copy of the repository in your GitHub account.

# Clone the forked repository to your local machine
git clone https://github.com/YOUR_USERNAME/euskalbar.git

# Navigate to the cloned directory
cd euskalbar

# Install the required dependencies (assuming the project uses npm)
npm install

Before making any changes, create a new branch for your task. This ensures that the main or master branch remains stable.

# Create a new branch (replace 'feature/your-branch-name' with a suitable name for your branch)
git checkout -b feature/your-branch-name

With your branch ready, you can start making changes to the code. Ensure that your code adheres to the project's coding standards and guidelines.

After making your changes, commit them with a descriptive commit message.

# Add the changed files to staging
git add .

# Commit the changes
git commit -m "Your descriptive commit message here"

Once you've committed your changes, push your branch to GitHub.

# Push your branch to GitHub
git push origin feature/your-branch-name

• Go to your forked Euskalbar repository on GitHub.
• Click on the "Pull requests" tab.
• Click the "New pull request" button.
• Choose your branch from the dropdown and ensure it's being merged into the correct target branch (usually main or master).
• Fill out the PR template with details about your changes, any related issues, and other relevant information.
• Click "Create pull request."

Once your PR is submitted, maintainers or other contributors will review your changes. They may provide feedback or request changes. Ensure to address any feedback to get your PR merged.

Thank you for your contribution to Euskalbar! Your efforts help improve the project for everyone.

(back to top)

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

(back to top)

We extend our deepest gratitude to the dedicated individuals who have played pivotal roles in the development, improvement, and support of Euskalbar. Their contributions have been instrumental in shaping the project and ensuring its continued success.

• Juanan Pereira Varela: Juanan laid the foundation of Euskalbar with his initial commits and development efforts. His vision set the direction for the project's journey.

• Asier Sarasua Garmendia: As a main developer, Asier's technical expertise and commitment have been invaluable. His contributions have significantly shaped the core functionalities of Euskalbar.

• Julen Ruiz Aizpuru: As another main developer, Julen's dedication and technical prowess have been crucial in ensuring the project's robustness and adaptability.

• Igor Leturia Azkarate: Igor's efforts in migrating Euskalbar to version 4 and transitioning it to the WebExtension format have ensured the project's compatibility with newer versions of Firefox, keeping it relevant and accessible to users.

• Mari Susperregi: Representing the Elhuyar Foundation, Mari has provided invaluable support by integrating dictionaries, ensuring that Euskalbar benefits from the backing of a renowned institution.

To each of these contributors and the broader community, we say thank you. Your passion, expertise, and commitment have made Euskalbar a beacon for the Basque language in the digital age.

(back to top)