@wbg-mde/repository/README.md

Managing all common method for file system CRUD operations.

# Metadata Editor Repository(@wbg-mde/repository)

This module handles the file system of Metadata Editor application. This module have all the general and remotely executed methods. Typescript is used to development and converted to Javascripit after compilation. This module manages  the following functionalities:

- Project configuration
- Export DDI
- Import DDI
- Nedb management
- Core i18n methods
- Core template manager methods
- Application resource path management
- File system management

### Installation

Install the dependencies and devDependencies.

```sh
npm install
```

Build the application
```sh
npm run build
```

Publish the application to npm
```sh
npm publish --access public
```

### Running the tests

Unit test are written for DDI, DublinCore and Geospatial study import/export. You can copy input files to `test-data/input` directory. Please see the commands to run unit test below.

#### `npm run test:ddi`

unit test to check the ddi import/export functionalities. Keep only ddi xml files to be tested in the `test-data/input/ddi` folder, remove other files.

flow of test execution :-

- import study from `test-data/input/ddi` directory
- export the imported files to `test-data/output/ddi`

#### `npm run test:dublincore`

unit test to check the dublincore import/export functionalities. Keep only dublincore rdf files to be tested in the `test-data/input/dublincore` folder, remove other files.

flow of test execution :-

- import study from `test-data/input/dublincore` directory
- export the imported files to `test-data/output/dublincore`

#### `npm run test:geospatial`

unit test to check the geospatial import/export functionalities. Keep only geospatial xml files to be tested in the `test-data/input/geospatial` folder, remove other files.

flow of test execution :-

- import study from `test-data/input/geospatial` directory
- export the imported files to `test-data/output/geospatial`

### Contributors
- Navin VI (navin.v.i@panapps.co)
- Anoop Xaviour (anoopx@panapps.co)
- Ghanashyam C Kartha (ghanashyam.c.k@panapps.co)
- Libin Thomas (libint@panapps.co)

License
----
MIT