Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mideind/velthyding

Web front end for Miðeind's machine translation engine
https://github.com/mideind/velthyding

icelandic icelandic-language icelandic-translation machine-translation nmt translation website

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README

        

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![node](https://img.shields.io/badge/node-19+-brightgreen.svg)
![Release](https://shields.io/github/v/release/mideind/Velthyding?display_name=tag)
[![Build](https://github.com/mideind/Velthyding/actions/workflows/eslint.yml/badge.svg)]()

# Velthyding.is

### Icelandic Machine Translation Website

## Introduction

_Velthyding.is_ is a web application frontend for [Miðeind](https://miðeind.is)'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](https://velthyding.is).

## Development

### Configuration

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

```bash
yarn install
```

To start the development server run

```bash
yarn start
```

To create a production build run

```bash
yarn build:prod
```

To create a staging build run

```bash
yarn build:staging
```

See the [package.json](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](https://github.com/airbnb/javascript/tree/master/react).
Linting is configured in `.eslintrc.json` and the code can be fixed using prettier by running

```bash
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.](https://mideind.is)

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.](mailto:[email protected])
to negotiate custom arrangements.