Skip to content

Latest commit

 

History

History
191 lines (130 loc) · 8.9 KB

README.md

File metadata and controls

191 lines (130 loc) · 8.9 KB
Raw

iSamples Web UI

A web app to search and discover iSamples records. The app is based on solr-faceted-search-react react library and CesiumJS Javascript library. The record data is managed by redux library.

npm initialization

In order to get all the necessary javascript packages installed, make sure you run the following command in the terminal after first checkout.

npm install

Development with solr-faceted-search-react

We use the solr-faceted-search-react repository as a npm dependency in this web app. As default, this webapp fetches the develop branch of the repository and uses that version for the component. To do local development with the component in this app, follow the below steps:

  1. Build the component library solr-faceted-search-react

Install the dependencies of the component to do local development. Inside the component library,

npm install
npm run build
  1. Link the component to this project

Create a symlink so that the webapp's component is pointing to the local repository we are working for development.

cd /path/to/component/library
npm link
cd /path/to/webapp
npm link /path/to/component/library
  1. Handle multiple versions of react

Installing the dependencies in the component library can lead two versions of react to exist, and you might see an error related to this. If so, resolve this by specifying to use only the webapp's version of react in both the webapp and the component.

cd /path/to/webapp
cd node_modules/react && npm link
cd ../react-dom && npm link react
cd /path/to/component/library
npm link react

Now, do development in the component and see how it works with the webapp by running npm run watch in the component.

Start the web app

After set up all dependencies, run the below command to start the app. Open http://localhost:3000 to view it in your browser.

npm start

Modify fields for the App

field.js contains all default set up constant fields for this app. Currently, it contains three parts.

  1. searchFields and sortFeidls for solr-faceted-search-react (the main record page).
    • Required property: field and type
    • Additional property:
      • label (the name would be shown in the page or default by field)
      • hidden (if the fields would be shown in the left pane)
      • collapse (if the shown fields would collapse, only work without hidden:true)
  2. Cesium Map:
    • Initial map camera state (default moorea)
    • The color schema
    • Default source list, if we will have more organization, we could add them here
  3. DOIs Schemas:
    • DOIs required fields provided by the backend.
    • DOIs default schema
    • iSamples default schema
    • Schema object rules
      • Object key is the field name
      • Property:
        • type: the field type
        • items: the value of field (array || string)
        • description: a string to describe the field

DOIs and UserInfo pages are unavailable locally

DOIs abd UserInfo pages are unavaulable locally because of the cross-origin issue. We use HttpOnly cookie for the authorization, the cookie would be only sent by browser with the same domain or enabled 'credentials': 'include'.

In order to enable these two pages, two methods:

  1. Please run iSamples_docker locally after moving updated isamples_webui to isamples_docker.
  2. Please run iSamples_inabox, change _server_base in the config.js to isamples_inabox server URL (http://localhost:8000), add 'credentials': 'include' in the both headers of fetch functions of two pages, and modify isb_web/main.py:
From

app.add_middleware(
    fastapi.middleware.cors.CORSMiddleware,
    allow_origins=["*"],
    allow_methods=["*"],
    allow_headers=["*"],
)

to 

app.add_middleware(
    fastapi.middleware.cors.CORSMiddleware,
    allow_credentials=True,
    allow_origins=["http://localhost:3000"],
    allow_methods=["*"],
    allow_headers=["*"],
)

Available Scripts

In the project directory, you can run:

npm run localdev

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Code Formatting

We've configured .editorconfig with the formatter settings for this project. Assuming you're using Visual Studio Code, you ought to be able to install the EditorConfig for VS code extension and formatting should just work.

Debugging

The .vscode project checked in has the correct launch target for launching the Chrome debugger. Start the node server, then launch the debugger and breakpoints should work out of the box.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

To learn solr-faceted-search-react library, check out the documentation. Since iSample web ui add new features to this library, you might also need to review the source code of iSamples version. In the current project, extension folder contains all custom isamples scripts that overwrite the original solr-faceted-search-react scripts.

To learn Cesium, check out the CesiumJS documentation.

The useful sources about the logic of how to deploy CeisumJS in the React app. Since the CesiumJS is not a react library, we need to use uncontrolled component to manipulate the DOM outside of the React Model.

  1. Manipulate the DOM outside of the React Model
  2. Controlled and uncontrolled react component

For the future development, it's a good idea to keep using redux framework to manage global states.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify