Web Client for Datashare
| | Status |
| --: | :-- |
| **CI checks** | [](https://github.com/ICIJ/datashare-client/actions/workflows/main.yml) |
| **Latest version** | [](https://github.com/ICIJ/datashare-client/releases/latest) |
| **Release date** | [](https://github.com/ICIJ/datashare-client/releases/latest) |
| **Open issues** | [](https://github.com/ICIJ/datashare/issues/) |
| **Documentation** | [](https://icij.github.io/datashare-client/) |
# Installation guide
## Datashare **Client**
You need [Yarn](https://yarnpkg.com/lang/en/docs/install/) installed on your machine (tested with version 1.22) and Node.js 20 or above (tested with version 20.19.2).
* Install dependencies:
```
yarn
```
* Serve with hot reload at localhost:9009
```
yarn serve
```
## Datashare **backend**
Datashare backend allows to index, find names and provide file preview or download. It must be run alongside the client for manual testing with the benefits of hot reloading with `yarn serve`.
To run the backend you must:
1. Get and install Datashare from [datashare.icij.org](https://datashare.icij.org/) ;
1. Refer to the [User Guide](https://icij.gitbook.io/datashare/) if you need help installing Datashare ;
2. Run Datashare on port `8080` with CORS: `datashare --tcpListenPort 8080`.
## Build Setup
``` bash
# install / update dependencies
yarn
# serve with hot reload at localhost:9009
yarn serve
# build for production with minification
yarn build
# lint and fix files
yarn lint --fix
# run unit tests
yarn test
# generate documentation
yarn doc
```