Skip to content

Web front end for Miðeind's machine translation engine

Notifications You must be signed in to change notification settings

mideind/Velthyding

Repository files navigation

License: MIT node Release Build

Velthyding.is

Icelandic Machine Translation Website

Introduction

Velthyding.is is a web application frontend for Miðeind's neural machine translation engine, implemented in Javascript and React.

The website translates text and documents between Icelandic and English.

Try Velthyding at https://velthyding.is.

Development

Configuration

You’ll need to have Node >= 19 and yarn >= 1.22. To install dependencies run

yarn install

To start the development server run

yarn start

To create a production build run

yarn build:prod

To create a staging build run

yarn build:staging

See the package.json file for more scripts and note that some commands use different .env files.

Linting

The code should follow the Airbnb React/JSX Style Guide. Linting is configured in .eslintrc.json and the code can be fixed using prettier by running

npx eslint 'src/**/*.{js,jsx}' --fix

Release

  • Bump the version number package.json.
  • Run yarn build:prod to create a production build.
  • Create a new release on GitHub.

Acknowledgements

This work was partially funded by the Language Technology Programme of the Icelandic Government, managed by Almannarómur.

License

Miðeind ehf.

Velthyding is copyright © 2023 Miðeind ehf.

This software is licensed under the MIT License:

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.

If you would like to use this software in ways that are incompatible with the standard MIT license, contact Miðeind ehf. to negotiate custom arrangements.