Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 2.38 KB

README.md

File metadata and controls

71 lines (49 loc) · 2.38 KB
Raw


Web Client for Datashare

Status
CI checks CircleCI
Code Climate Code Climate
Latest version Latest version
Release date Release date
Open issues Open issues
Documentation Storybook JSDoc

Installation guide

Datashare Client

You need Yarn installed on your machine (tested with version 1.22) and Node.js 18 or above (tested with version 18.19).

  • 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 ;
  2. Refer to the User Guide if you need help installing Datashare ;
  3. Run Datashare on port 8080 with CORS: datashare --tcpListenPort 8080.

Build Setup

# 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