Skip to content

Commit

Permalink
docs: add general info (#271)
Browse files Browse the repository at this point in the history
  • Loading branch information
lpatiny committed Oct 22, 2022
1 parent 6aa3b0e commit 6f36ab0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,25 @@ React components to build analysis UI
</p>
</h3>

## Introduction

Science have specific requirements to display and process data especially in chemistry for which a huge amount of techniques allow to characterize sample.

This project will allow to simplify the process of creating web application that allows not only to visualize but also to process and extract information from measurements.

This project is composed of 2 parts:

- src/components: a set of reusable components that are published in the npm package and can be developed locally using `npm run dev`
- src/app: a playground in which we combine the components and many other project to test ideas and limitation of the design. It can be tested locally using `npm run dev-app`

## Principle of the application

The application has a state containing 3 properties:

- data: containing information related to data
- view: containing the information related to what is displayed in which module
- prefs: that will contain user defined preferences for the application

## Testing the demo application

- [From some JCAMP-DX files](https://zakodium-oss.github.io/analysis-ui-components/?filelist=https://zakodium-oss.github.io/analysis-dataset/jdx.json)
Expand Down

0 comments on commit 6f36ab0

Please sign in to comment.