source: main/trunk/model-interfaces-dev/atea/korero-maori-asr/README.md@ 35496

Last change on this file since 35496 was 35496, checked in by cstephen, 3 years ago

Update README

File size: 1.1 KB
Line 
1# Korero Maori ASR Interface
2
3A Greenstone 3 interface for the Atea Project, allowing people to easily utilise the ASR service of https://koreromaori.io to transcribe reo Māori audio files.
4
5## Project setup
6
7Ensure that [node.js](https://nodejs.org) is on your path.
8
9You will also need to setup the Greenstone `koreromaori-proxy` extension. Visit https://trac.greenstone.org/browser/gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy to get the source.
10
11```
12npm install
13```
14
15### Compile and hot-reload for development
16
17This will open a development webserver on [localhost:8080](http://localhost:8080), that is detached from the running Greenstone instance (provided you haven't removed development-specific code).
18
19```
20npm run serve
21```
22
23### Compile and minify for production
24
251. In `vue.config.js`, uncomment the `publicPath` property, and optionally change it to point to where your production distribution will be placed relative to the interface.
26
272. Build the project.
28 ```
29 npm run build
30 ```
31
32### Lint and fix files
33
34This uses the settings in `.eslintrc.js` to lint the project, and attempts to fix mistakes accordingly.
35
36```
37npm run lint
38```
Note: See TracBrowser for help on using the repository browser.