https://github.com/os-climate/osc-dm-marketplace-ux

Climate Data Bazaar: User Interface
https://github.com/os-climate/osc-dm-marketplace-ux

Last synced: 7 days ago
JSON representation

Climate Data Bazaar: User Interface

• Host: GitHub
• URL: https://github.com/os-climate/osc-dm-marketplace-ux
• Owner: os-climate
• License: mit
• Created: 2024-05-08T16:40:57.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-11-01T18:41:59.000Z (13 days ago)
• Last Synced: 2024-11-01T19:28:26.503Z (13 days ago)
• Language: TypeScript
• Size: 210 KB
• Stars: 1
• Watchers: 5
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


> [!IMPORTANT]

> On June 26 2024, Linux Foundation announced the merger of its financial services umbrella, the Fintech Open Source Foundation ([FINOS](https://finos.org)), with OS-Climate, an open source community dedicated to building data technologies, modeling, and analytic tools that will drive global capital flows into climate change mitigation and resilience; OS-Climate projects are in the process of transitioning to the [FINOS governance framework](https://community.finos.org/docs/governance); read more on [finos.org/press/finos-join-forces-os-open-source-climate-sustainability-esg](https://finos.org/press/finos-join-forces-os-open-source-climate-sustainability-esg)

# osc-dm-marketplace-ux - BGS Server for Data Mesh Registry - User Interface

This project is the Bazaar (Marketplace) for Broda Group

Software's Ecosystem Platform. The Bazaar is a catalog, or marketplace, that

makes it easy for users to find, consume, share, and trust

data.

Full documentation is available in in the

[osc-dmmesh-doc](https://github.com/brodagroupsoftware/osc-dmmesh-doc)

repo.

This application interacts with other applications. You can run

the full set of applications by following instructions in the

[osc-dmmesh-doc](https://github.com/brodagroupsoftware/osc-dmmesh-doc)

repo.

The remaining sections explain how to Dockerize the application

as well as providing a few developer notes.

## Prerequisites

None noted.

## Setting up your Environment

Some environment variables are used by various coded and scripts.

Setup your environment as follows (note that "source" is used)

~~~~

source ./bin/environment.sh

~~~~

## React Application

This project was bootstrapped with

[Create React App](https://github.com/facebook/create-react-app)

and follows normal React practices.

## Proxy Setup to Access Server Information

Note that this application access data residing on a server.

It uses basic HTTP request, but this does require a proxy to be

setup such that CORS issues to not surface.

The following line is added to the package.json

~~~~

"proxy": "http://127.0.0.1:8000",

~~~~

The "package.json" should look similar to the following

(note the "proxy" tag):

~~~~

{

  "name": "osc-dm-marketplace-ux",

  "version": "0.1.0",

  "private": true,

  "proxy": "http://127.0.0.1:8000",

  "dependencies": {

    "@emotion/react": "^11.11.1",

    "@emotion/styled": "^11.11.0",

~~~~

## Dockerizing the Application

The application is designed to run in a Docker container.

To create the Docker container ("dockerizing"), issue the

following command:

~~~~

$PROJECT_DIR/bin/dockerize.sh

~~~~

## Running the Application

The following command will start the standalone

application locally.

~~~~

$PROJECT_DIR/app/start.sh

~~~~